Alternate User Ids

Retrieve user’s Alternate User Ids

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/alternate_user_ids/

The API is mapped to UserAlternateUserIdGetListRequest

Additional information

Response JSON Object:

• alternateUserIds (array) – a list of alternate user ids as defined as Alternate User Id attributes. Limit to 5 entries: the first is the original User Id, the other 4 are alternate User Ids.

Retrieve a user’s Alternate User Id

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/alternate_user_ids/(string: instance_name)/

The API is mapped to UserAlternateUserIdGetInstanceRequest

Additional information

Request JSON Object:

• alternateUserId (string) – the alternateUserId. Length in range 1 - 161.

• description (string) – the description. Length in range 1 - 80.

Create a user’s Alternate User Id

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/alternate_user_ids/

The API is mapped to UserAlternateUserIdAddRequest

Additional restrictions

Request JSON Object:

• user_id (string) – the User Id. Length in range 1 - 161.

• alternateUserId (string) – the alternateUserId. Length in range 1 - 161.

• description (string) – (optional) the description. Length in range 1 - 80.

Update a user’s Alternate User Id

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/alternate_user_ids/(string: instance_name)/

The API is mapped to UserAlternateUserIdModifyRequest

Additional restrictions

Request JSON Object:

• user_id (string) – the User Id. Length in range 1 - 161.

• instance_name (string) – the old alternateUserId. Length in range 1 - 161.

• alternateUserId (string) – (optional) the new alternateUserId. Length in range 1 - 161.

• description (string) – (optional) the description. Length in range 1 - 80.

Delete a user’s Alternate User Id

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/alternate_user_ids/(string: instance_name)/

The API is mapped to UserAlternateUserIdDeleteRequest

Additional restrictions

Request JSON Object:

• user_id (string) – the User Id. Length in range 1 - 161.

• instance_name (string) – the old alternateUserId. Length in range 1 - 161.

Alternate User Id attributes

Name	Type	Method	Description
		GET
alternateUserId	String	A	The Alternate User Id. Length in range 1 - 161.
description	String	A	The description. Length in range 1 - 80.