group-alias
Create a group alias
This endpoint creates or updates a group alias.
Method | Path |
---|---|
POST | /identity/group-alias |
Parameters
name
(string: entity-<UUID>)
– Name of the group alias.id
(string: <optional>)
- ID of the group alias. If set, updates the corresponding existing group alias.mount_accessor
(string: "")
– Mount accessor which this alias belongs to.canonical_id
(string: "")
- ID of the group to which this is an alias.
Sample payload
Sample request
Sample response
Update group alias by ID
This endpoint is used to update an existing group alias.
Method | Path |
---|---|
POST | /identity/group-alias/id/:id |
Parameters
id
(string: <optional>)
- ID of the group alias.name
(string: entity-<UUID>)
– Name of the group alias.mount_accessor
(string: "")
– Mount accessor which this alias belongs to.canonical_id
(string: "")
- ID of the group to which this is an alias.
Sample payload
Sample request
Sample response
Read group alias by ID
This endpoint queries the group alias by its identifier.
Method | Path |
---|---|
GET | /identity/group-alias/id/:id |
Parameters
id
(string: <required>)
– ID of the group alias.
Sample request
Sample response
Delete group alias by ID
This endpoint deletes a group alias.
Method | Path |
---|---|
DELETE | /identity/group-alias/id/:id |
Parameters
id
(string: <required>)
– ID of the group alias.
Sample request
List group alias by ID
This endpoint returns a list of available group aliases by their identifiers.
Method | Path |
---|---|
LIST | /identity/group-alias/id |
GET | /identity/group-alias/id?list=true |
Sample request
Sample response