- Home
- Resources
- ExternalUserMappingsResource
GET /externalUserMappings
Returns a list of the external user mappings configured in the system.
Request Parameters
name |
type |
description |
default |
view |
query |
|
summary |
Response Body
media type |
data type |
description |
application/json |
ApiExternalUserMappingList
(JSON) |
A list of external user mappings. |
POST /externalUserMappings
Creates a list of external user mappings
Request Body
media type |
data type |
description |
application/json |
ApiExternalUserMappingList
(JSON) |
List of external user mappings to create. |
Response Body
media type |
data type |
description |
application/json |
ApiExternalUserMappingList
(JSON) |
Information about created external user mappings. |
DELETE /externalUserMappings/{uuid}
Deletes an external user mapping from the system.
Request Parameters
name |
type |
description |
default |
uuid |
path |
The uuid of the external user mapping to delete. |
n/a |
Response Body
media type |
data type |
description |
application/json |
ApiExternalUserMapping
(JSON) |
The details of the deleted external user mapping role. |
GET /externalUserMappings/{uuid}
Returns detailed information about an external user mapping.
Request Parameters
name |
type |
description |
default |
uuid |
path |
The external user mapping to read. |
n/a |
Response Body
media type |
data type |
description |
application/json |
ApiExternalUserMapping
(JSON) |
The external user mapping's information. |
PUT /externalUserMappings/{uuid}
Updates the given external user mapping's information.
Request Parameters
name |
type |
description |
default |
uuid |
path |
Uuid of the external user mapping being updated. |
n/a |
Request Body
media type |
data type |
description |
application/json |
ApiExternalUserMapping
(JSON) |
The external user mapping information. |