CommunicationEmailEmailAliasManager

Designed for those interested in developing platforms to consume API, and understanding API in more detail

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: /domains/legacy/communication/email/emailAliasManager

Version: v1

Default response content-types: application/json, application/xml
Schemes: https

Summary

Path Operation Description
/ GET

Check alias availability

/all/{netid} GET

Get all aliases for a NetID

/ping/{anyText} GET

Service healthcheck

/{alias} DELETE

Delete an alias

GET

Get information about specific alias

POST

Create Alias

PUT

Expire or release alias

Paths

Check alias availability

GET /

Tags: EmailAliasManagerService

Check if current user can use alias in question

alias

Alias

query string
netid

Individual person identifier

query string

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

401 Unauthorized

Bad request - unable to interpret body of the message.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Get all aliases for a NetID

GET /all/{netid}

Tags: EmailAliasManagerService

Get all aliases for a NetID

netid

individual person identifier

path string

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

401 Unauthorized

Bad request - unable to interpret body of the message.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Service healthcheck

GET /ping/{anyText}

Tags: EmailAliasManagerService

Service healthcheck

anyText path string

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

401 Unauthorized

Bad request - unable to interpret body of the message.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Delete an alias

DELETE /{alias}

Tags: EmailAliasManagerService

Delete an alias

alias

Alias

path string
authId

Authorization identification to delete Alias

query string

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

401 Unauthorized

Bad request - unable to interpret body of the message.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Get information about specific alias

GET /{alias}

Tags: EmailAliasManagerService

Get information about specific alias

alias

alias

path string

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

401 Unauthorized

Bad request - unable to interpret body of the message.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Create Alias

POST /{alias}

Tags: EmailAliasManagerService

Creates a new Alias

Request body to create Alias

alias

alias

path string

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

401 Unauthorized

Bad request - unable to interpret body of the message.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Expire or release alias

PUT /{alias}

Tags: EmailAliasManagerService

Expire or release alias

To modify an alias use active OR add and delete

alias

Alias

path string

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

401 Unauthorized

Bad request - unable to interpret body of the message.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Schema definitions

Aliases: object

Alias: object
netid: string
alias: string
forwardingAddress: string

createAlias: object

Result: string

createAliasBody: object

forwardList: string
netId: string

deleteAlias: object

Results: string

getAlias: object

Results: string

getAliasInfo: object

Aliases: Aliases
Expired: boolean

getAllAliases: object

Aliases: object[]
object
Alias: Aliases

putBody: object

active: boolean
add: string
delete: string
Service Path: 
/domains/legacy/communication/email/emailAliasManager
Domain or University API: 
/domains/D/communication/email/emailAliasManager

Community

 

Don't see your question listed here? Ask!