GET
URI:
- /api/v1/realm
- /api/v1/realm/[id]
- /api/v1/realm?name=***
Input fields:
| Field Name | Type | Required |
Description |
|---|---|---|---|
| name | string | No | The realm name. |
|
id |
string |
No |
The realm ID. |
|
deleted |
boolean |
No |
Get the deleted realm record. |
Successful response fields:
| Field name | Type | Description |
|---|---|---|
| description | string | A brief description about the realm. |
| deleted_at | datetime | The deleted timestamp, if the realm is not deleted, the field is None. |
| name | string | The realm name. |
| is_default | boolean | If the realm is the default realm. |
| id | string | The realm ID. |
Response codes:
| Code | Response content | Description |
|---|---|---|
| 200 OK | Realm(s) info are successfully returned. | |
| 404 Not Found | Realm ID was not found | Cannot find realm with Realm ID. |
Example request body:
None
Example of successful response body:
Return:
[
{
'description': 'abc',
'deleted_at': None,
'name': 'abc',
'is_default': False,
'id': '12345678-abcd-efgh-1234-xxxxxxxxxxxx'
}
]
|
The response body will be a realm dictionary if the API input field is set to request a specific realm, for example, get realm by its ID. Otherwise, the response body will be a list of realm dictionaries. |