ApiAccesses.get

Returns ApiAccess with given id

Responses

🟢200OK

application/json

ApiAccess data

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (ApiAccess)

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity. Must match with Application id.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

string

optional

Email address.

Example:

string

is_active

boolean

optional

Boolean value.

Example:

false

last_used

string <date-time>

optional

Datetime information.

Example:

2019-01-01T00:00:00

permissions

object

optional

Field containing json.

type

enum<integer>

read-onlyrequired

Integer enum value: 1 - Basic, 2 - OAuth

Allowed values:

Example:

name

string

required

Name for the api access.

Example:

string

username

string

optional

Example:

string

plain_password

string

optional

Example:

string

Example

{
    "success": true,
    "data": {
        "is_delete_protected": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "email": "string",
        "is_active": false,
        "last_used": "2019-01-01T00:00:00",
        "permissions": {},
        "type": 1,
        "name": "string",
        "username": "string",
        "plain_password": "string"
    }
}

🟠404Record Not Found

🔴500Server Error

Request

Request samples

Responses