Token Profile API (2.17.0)
Download OpenAPI specification:Download
REST API for managing Token Profiles in the platform
Details of Token Profile
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
path Parameters
| tokenInstanceUuid required | string Token Instance UUID |
| uuid required | string Token Profile UUID |
Responses
Response samples
- 200
- 400
- 403
- 404
- 502
- 503
Content type
application/json
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "attributes": [
- {
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "version": "v2"
}
], - "customAttributes": [
- {
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "version": "v2"
}
], - "tokenInstanceStatus": "Connected",
- "enabled": true,
- "usages": [
- "sign"
]
}Edit Token Profile
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
path Parameters
| tokenInstanceUuid required | string Token Instance UUID |
| uuid required | string Token Profile UUID |
Request Body schema: application/jsonrequired
| description | string Description of Token Profile |
required | Array of objects (RequestAttribute) List of Attributes for Token Profile |
Array of objects (RequestAttribute) List of Custom Attributes | |
| enabled | boolean Enabled flag - true = enabled; false = disabled |
| usage | Array of strings (KeyUsage) Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap" Usages for the Key |
Responses
Request samples
- Payload
Content type
application/json
{- "description": "string",
- "attributes": [
- {
- "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true,
- "contentType": "string"
}
], - "version": "v2"
}
], - "customAttributes": [
- {
- "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true,
- "contentType": "string"
}
], - "version": "v2"
}
], - "enabled": true,
- "usage": [
- "sign"
]
}Response samples
- 204
- 400
- 403
- 404
- 422
- 502
- 503
Content type
application/json
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "attributes": [
- {
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "version": "v2"
}
], - "customAttributes": [
- {
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "version": "v2"
}
], - "tokenInstanceStatus": "Connected",
- "enabled": true,
- "usages": [
- "sign"
]
}Update Key Usage
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
path Parameters
| tokenInstanceUuid required | string Token Instance UUID |
| tokenProfileUuid required | string Token Profile UUID |
Request Body schema: application/jsonrequired
| usage required | Array of strings (KeyUsage) Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap" Usages for the Key |
Responses
Request samples
- Payload
Content type
application/json
{- "usage": [
- "sign"
]
}Response samples
- 400
- 403
- 404
- 502
- 503
Content type
application/json
{- "message": "Error message"
}Update Key Usages for Multiple Token Profiles
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
Request Body schema: application/jsonrequired
| usage required | Array of strings (KeyUsage) Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap" Usages for the Key |
| uuids required | Array of strings <uuid> [ items <uuid > ] Token Profile UUIDs |
Responses
Request samples
- Payload
Content type
application/json
{- "usage": [
- "sign"
], - "uuids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}Response samples
- 400
- 403
- 502
- 503
Content type
application/json
{- "message": "Error message"
}Create Token Profile
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
path Parameters
| tokenInstanceUuid required | string Token Instance UUID |
Request Body schema: application/jsonrequired
| name required | string Token Profile name |
| description | string Token Profile description |
required | Array of objects (RequestAttribute) List of Attributes to create Token Profile |
Array of objects (RequestAttribute) List of Custom Attributes | |
| enabled | boolean Default: false Enabled flag - true = enabled; false = disabled |
| usage | Array of strings (KeyUsage) Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap" Usages for the Key |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "string",
- "description": "string",
- "attributes": [
- {
- "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true,
- "contentType": "string"
}
], - "version": "v2"
}
], - "customAttributes": [
- {
- "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true,
- "contentType": "string"
}
], - "version": "v2"
}
], - "enabled": false,
- "usage": [
- "sign"
]
}Response samples
- 201
- 400
- 403
- 404
- 422
- 502
- 503
Content type
application/json
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "attributes": [
- {
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "version": "v2"
}
], - "customAttributes": [
- {
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "version": "v2"
}
], - "tokenInstanceStatus": "Connected",
- "enabled": true,
- "usages": [
- "sign"
]
}Enable multiple Token Profiles
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
Request Body schema: application/jsonrequired
Token Profile UUIDs
Array
string
Responses
Request samples
- Payload
Content type
application/json
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]Response samples
- 400
- 403
- 502
- 503
Content type
application/json
{- "message": "Error message"
}Disable multiple Token Profiles
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
Request Body schema: application/jsonrequired
Token Profile UUIDs
Array
string
Responses
Request samples
- Payload
Content type
application/json
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]Response samples
- 400
- 403
- 502
- 503
Content type
application/json
{- "message": "Error message"
}List of available Token Profiles
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
query Parameters
| enabled | boolean |
Responses
Response samples
- 200
- 400
- 403
- 502
- 503
Content type
application/json
[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "tokenInstanceStatus": "Connected",
- "enabled": true,
- "usages": [
- "sign"
]
}
]Delete multiple Token Profiles
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
Request Body schema: application/jsonrequired
Token Profile UUIDs
Array
string
Responses
Request samples
- Payload
Content type
application/json
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]Response samples
- 400
- 403
- 422
- 502
- 503
Content type
application/json
{- "message": "Error message"
}