Alias Search

Overview

Use this API to retrieve aliases in a department.

Permissions

All of the following are required:

  • If logged in user is a department user:
    • User must have 'View' action on 'Aliases' resource.
    • The department must be the home department of the user, or a department in which the user is a foreign user.
  • If the logged in user is a global user, one of the below is required:
    • User must have 'Administer' permission on the department provided in the request.
    • User must have one of following privileges: 'View partition resources', 'Manage partition resources'.
SecurityoAuthUser or oAuthClient
Request
path Parameters
id
required
string

Department ID

Examples:
999
query Parameters
$attribute
string

Available values: all, description, automaticBCC, sendEmailTo, redirectionEmailAddresses

Examples:
Attributes 'automaticBCC' and 'description' are returned in server response.
$attribute=automaticBCC,description
All the attributes are returned in server response.
$attribute=all
$sort
string

Objects returned in server response are sorted based on the attribute supplied under $sort.

Enum: "id" "name"
$order
string

Common query parameter $order.

Enum: "asc" "desc"
header Parameters
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Responses
200

OK

204

No Content

  • No matches were found for given search criteria.
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not Acceptable

500

Internal server error

get/department/{id}/aliases
Request samples
Response samples
application/json
    

  • GET /core/departmentmgr/v3/department/999/aliases?$sort=name&$order=desc
    • 

  • This example demonstrates the following:
      

    • Search aliases in a department.
      • 

    • Retrieve summary attributes of alias.
      • 

    • Sorting on name.
      • 

    

    • 



{
  • "alias": [
    ]
}