[{"label":"Latest (v1.0)","version":"latest"}]
csp

ApiTokenDetailsDto

The API token details.


Properties

string
acct Optional

The identifier of the user, configured to log in to the Identity provider.


allowedScopes Optional

The allowed general, organization and service scopes of access.


integer as int64
createdAt Optional

The timestamp the token was created at (measured in number of seconds since 1/1/1970 UTC).


boolean
deactivated Optional

string
deactivatedUpdatedBy Optional

The user who updated the token’s isDeactivated state


integer as int64
deactivatedUpdatedOn Optional

The timestamp the token’s isDeactivated was last updated (measured in number of seconds since 1/1/1970 UTC).


string
domain Optional

The identity provider (IdP) domain of the user.


integer as int64
expiresAt Optional

The timestamp the token expires at (measured in number of seconds since 1/1/1970 UTC).


string
idpId Optional

The identifier of the identity provider.


integer as int64
lastUsedAt Optional

The timestamp the token was last used (measured in number of seconds since 1/1/1970 UTC).


string
orgId Optional

Unique identifier (GUID) of the organization.


array of string
scope Optional

The scope of access needed for the token


string
token Optional

The value of the API token.


string
tokenId Optional

The unique identifier of the API token.


string
tokenName Optional

The name of the API token.


string
userId Optional

The unique identifier of the user, on behalf of which the token was issued.


string
username Optional

Deprecated. The username of the user to whom the api token belongs

JSON Example

{
	"acct": "string",
	"allowedScopes": {
		"generalScopes": [
			"string"
		],
		"organizationScopes": {
			"allPermissions": false,
			"allRoles": false,
			"keptInToken": [
				"ROLES"
			],
			"permissions": [
				{
					"permissionId": "string",
					"resources": [
						"string"
					]
				}
			],
			"roles": [
				{
					"name": "string",
					"resource": "string"
				}
			]
		},
		"servicesScopes": [
			{
				"allPermissions": false,
				"allRoles": false,
				"keptInToken": [
					"ROLES"
				],
				"permissions": [
					{
						"permissionId": "string",
						"resources": [
							"string"
						]
					}
				],
				"roles": [
					{
						"name": "string",
						"resource": "string"
					}
				],
				"serviceDefinitionId": "string"
			}
		]
	},
	"createdAt": 0,
	"deactivated": false,
	"deactivatedUpdatedBy": "string",
	"deactivatedUpdatedOn": 0,
	"domain": "string",
	"expiresAt": 0,
	"idpId": "string",
	"lastUsedAt": 0,
	"orgId": "string",
	"scope": [
		"string"
	],
	"token": "string",
	"tokenId": "string",
	"tokenName": "string",
	"userId": "string",
	"username": "string"
}
[{"label":"Latest (v1.0)","version":"latest"}]
csp
Returned By

Get API Token Details

Feedback

Was this page helpful?