Duo Alias API

The Duo Alias API allows for addition and removal of aliases within the Duo Console. For information on how aliases work in Duo, see the Duo documentation.

Add Alias

Endpoint: https://duo-alias.identity.tamu.edu/api/add

HTTP Method: POST

Authentication Required: Yes

Authentication: Include the x-api-key header provided by Identity Security.

Request Body Format:

{
    "netid":"[string]",
    "alias":"[string]"
}

Example:

{
    "netid":"john.smith",
    "alias":"jsmith"
}

Successful Response

Condition: New alias was successfully added to the account.

Code: 200

Content: Alias {alias} added for user {user}.

Error Responses

Remove Alias

Endpoint: https://duo-alias.identity.tamu.edu/api/remove

HTTP Method: POST

Authentication Required: Yes

Authentication: Include the x-api-key provided by Identity Security.

Request Body Format:

{
    "netid":"[string]",
    "alias":"[string]"
}

Example:

{
    "netid":"john.smith",
    "alias":"jsmith"
}

Successful Response

Condition: New alias was successfully added to the account.

Code: 200

Content: Alias {alias} removed for user {user}.

Error Responses