GET /external/api/v3/role?name={name}
Get the id of a role by the role name.
Request Information
URI Parameters
Name | Description | Type | Additional information | Nullable |
---|---|---|---|---|
name | string |
Required |
False |
Body Parameters
None.
Response Information
Resource Description
RoleModelName | Description | Type | Additional information | Nullable |
---|---|---|---|---|
Name | string |
None |
False | |
Id | globally unique identifier |
Required |
False |
Response Formats
application/json, text/json
Sample:
{ "Name": "sample string 1", "Id": "3d8c927d-a3c7-4b63-bf96-4856e77c4946" }
application/xml, text/xml
Sample:
<RoleModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models"> <Id>3d8c927d-a3c7-4b63-bf96-4856e77c4946</Id> <Name>sample string 1</Name> </RoleModel>
Response Status Codes
Status Code | Name | Description |
---|---|---|
200 | OK | The request has succeeded. |
400 | Bad Request | Fulfilling the request would cause an invalid state. Request needs modification. |
401 | Unauthorized | Missing or invalid authentication token. |
403 | Forbidden | Server refuses to authorize the request. |
408 | Request Timeout | The server timed out waiting for the request. |
429 | Too Many Requests | Too many requests in a given amount of time. |
500 | Internal Server Error | The server encountered an unexpected condition which prevented it from fulfilling the request. |
503 | Service Unavailable | The server is unable to proces the request at the moment, try again later. |