CZERTAINLY Auth API (2.13.1)

Download OpenAPI specification:Download

CZERTAINLY: info@czertainly.com URL: https://www.czertainly.com License: MIT License

REST API for managing user, roles, and permissions in the platform

CZERTAINLY Documentation

User Management

User Management API

Get user details

path Parameters

userUuid

required

string

User UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Update User

path Parameters

userUuid

required

string

User UUID

Request Body schema: application/json
required

description	string Description of the user
firstName	string First name of the user
lastName	string Last name of the user
email required	string Email of the user
groupUuids	Array of strings Groups UUIDs of the user (set to empty list to remove certificate from all groups)
certificateData	string Base64 Content of the admin certificate
certificateUuid	string UUID of the existing certificate in the Inventory. Mandatory if certificate is not provided
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"groupUuids": ["string"
],
"certificateData": "string",
"certificateUuid": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Delete User

path Parameters

userUuid

required

string

User UUID

Responses

Response samples

400
403
404

Content type

application/json

{"statusCode": 0,
"code": "string",
"message": "string"
}

Add role to User

path Parameters

userUuid required	string User UUID
roleUuid required	string Role UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Remove role from User

path Parameters

userUuid required	string User UUID
roleUuid required	string Role UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

List Users

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true
}
]

Create User

Request Body schema: application/json
required

username required	string Username of the user
description	string Description of the user
firstName	string First name of the user
lastName	string Last name of the user
email	string Email of the user
groupUuids	Array of strings Groups UUIDs of the user
enabled	boolean Status of the user. True = Enabled, False = Disabled
certificateData	string Base64 Content of the user certificate
certificateUuid	string UUID of the existing certificate in the Inventory
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"username": "user1",
"description": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"groupUuids": ["string"
],
"enabled": true,
"certificateData": "string",
"certificateUuid": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

201
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Identify User

Request Body schema: application/json
required

certificateContent	string Base64 Content of the certificate
authenticationToken	string Authentication Token

Responses

Request samples

Payload

Content type

application/json

{"certificateContent": "string",
"authenticationToken": "string"
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Get User Roles

path Parameters

userUuid

required

string

User UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
]

Add roles to User

path Parameters

userUuid

required

string

User UUID

Request Body schema: application/json
required

Role UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Enable User

path Parameters

userUuid

required

string

User UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Disable User

path Parameters

userUuid

required

string

User UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Get User permissions

path Parameters

userUuid

required

string

User UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"allowAllResources": true,
"resources": [{"name": "string",
"allowAllActions": true,
"actions": ["string"
],
"objects": [{"uuid": "string",
"name": "string",
"allow": ["string"
],
"deny": ["string"
]
}
]
}
]
}

Authentication Management

Authentication Management API

Profile Authorization

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Update User Profile

Request Body schema: application/json
required

description	string Description of the user
firstName	string First name of the user
lastName	string Last name of the user
email required	string Email of the user
groupUuids	Array of strings Groups UUIDs of the user (set to empty list to remove certificate from all groups)
certificateData	string Base64 Content of the admin certificate
certificateUuid	string UUID of the existing certificate in the Inventory. Mandatory if certificate is not provided
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"groupUuids": ["string"
],
"certificateData": "string",
"certificateUuid": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Get Auth Resources

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"displayName": "string",
"listObjectsEndpoint": "string",
"objectAccess": true,
"actions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"displayName": "string"
}
]
}
]

Get List of objects for Object Access

path Parameters

resourceName

required

string (Resource)

Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers"

Example: Name

Resource Name

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]

Role Management

Role Management API

Get role details

path Parameters

roleUuid

required

string

Role UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true,
"users": [{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Update Role

path Parameters

roleUuid

required

string

Role UUID

Request Body schema: application/json
required

name	string Name of the role
description	string Description for the role
email	string Role contact email
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"email": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true,
"users": [{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Delete Role

path Parameters

roleUuid

required

string

Role UUID

Responses

Response samples

400
403
404

Content type

application/json

{"statusCode": 0,
"code": "string",
"message": "string"
}

Update Resource Objects to a Role

path Parameters

roleUuid required	string Role UUID
resourceUuid required	string Resource UUID
objectUuid required	string Object UUID

Request Body schema: application/json
required

uuid required	string UUID of the Object
name required	string Name of the Object
allow	Array of strings Allowed Action list
deny	Array of strings Denied Action list

Responses

Request samples

Payload

Content type

application/json

{"uuid": "string",
"name": "string",
"allow": ["string"
],
"deny": ["string"
]
}

Response samples

400
403
404

Content type

application/json

{"statusCode": 0,
"code": "string",
"message": "string"
}

Update Resource Objects to a Role

path Parameters

roleUuid required	string Role UUID
resourceUuid required	string Resource UUID
objectUuid required	string Object UUID

Responses

Response samples

400
403
404

Content type

application/json

{"statusCode": 0,
"code": "string",
"message": "string"
}

List Roles

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true
}
]

Create Role

Request Body schema: application/json
required

name	string Name of the role
description	string Description for the role
email	string Role contact email
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"email": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

201
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true,
"users": [{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Get Permissions of a Role

path Parameters

roleUuid

required

string

Role UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"allowAllResources": true,
"resources": [{"name": "string",
"allowAllActions": true,
"actions": ["string"
],
"objects": [{"uuid": "string",
"name": "string",
"allow": ["string"
],
"deny": ["string"
]
}
]
}
]
}

Add permissions to Role

path Parameters

roleUuid

required

string

Role UUID

Request Body schema: application/json
required

allowAllResources required	boolean Allow all resources, True = Yes, False = No
	Array of objects (ResourcePermissionsRequestDto) Resources

Responses

Request samples

Payload

Content type

application/json

{"allowAllResources": true,
"resources": [{"name": "string",
"allowAllActions": true,
"actions": ["string"
],
"objects": [{"uuid": "string",
"name": "string",
"allow": ["string"
],
"deny": ["string"
]
}
]
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"allowAllResources": true,
"resources": [{"name": "string",
"allowAllActions": true,
"actions": ["string"
],
"objects": [{"uuid": "string",
"name": "string",
"allow": ["string"
],
"deny": ["string"
]
}
]
}
]
}

Get Resource Objects of a Role

path Parameters

roleUuid required	string Role UUID
resourceUuid required	string Resource UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "string",
"name": "string",
"allow": ["string"
],
"deny": ["string"
]
}
]

Add Resource Objects to a Role

path Parameters

roleUuid required	string Role UUID
resourceUuid required	string Resource UUID

Request Body schema: application/json
required

Array

uuid required	string UUID of the Object
name required	string Name of the Object
allow	Array of strings Allowed Action list
deny	Array of strings Denied Action list

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "string",
"name": "string",
"allow": ["string"
],
"deny": ["string"
]
}
]

Response samples

400
403
404

Content type

application/json

{"statusCode": 0,
"code": "string",
"message": "string"
}

Get Role Users

path Parameters

roleUuid

required

string

Role UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true
}
]

Add users to Role

path Parameters

roleUuid

required

string

Role UUID

Request Body schema: application/json
required

User UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"systemRole": true,
"users": [{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"enabled": true,
"systemUser": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Get Resources of a Role

path Parameters

roleUuid required	string Role UUID
resourceUuid required	string Resource UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"name": "string",
"allowAllActions": true,
"actions": ["string"
],
"objects": [{"uuid": "string",
"name": "string",
"allow": ["string"
],
"deny": ["string"
]
}
]
}

CZERTAINLY Auth API (2.13.1)

User Management

Get user details

path Parameters

Responses

Response samples

Update User

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete User

path Parameters

Responses

Response samples

Add role to User

path Parameters

Responses

Response samples

Remove role from User

path Parameters

Responses

Response samples

List Users

Responses

Response samples

Create User

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Identify User

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get User Roles

path Parameters

Responses

Response samples

Add roles to User

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Enable User

path Parameters

Responses

Response samples

Disable User

path Parameters

Responses

Response samples

Get User permissions

path Parameters

Responses

Response samples

Authentication Management

Profile Authorization

Responses

Response samples

Update User Profile

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Auth Resources

Responses

Response samples

Get List of objects for Object Access

path Parameters

Responses

Response samples

Role Management

Get role details

path Parameters

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required