Sign in

v1

latestSwagger 2.02026-07-13285166341.1 KB
AuthorizationCodeDefinitions

Get an authorization code definition by its ID

No Documentation Found.

get/api/v2/AuthorizationCodeDefinitions/{id}

Path parameters

idstring required

The ID of the authorization code definition.

Response

OK

IDstring

The ID of the authorization code definition. Read only.

AuthorizationIDstring

The value used for securing codes generated.

Namestring required

The name of the authorization code definition. May not be updated.

Descriptionstring

A description of this definition. May not be updated.

CreatedByUserIDinteger

The ID of the user that created this definition. Read only.

CreatedDatestring date-time

A timestamp of when this definition was created. Read only.

IsDeletedboolean

Indicates whether this definition is enabled. True if generating codes is disabled.

DeletedByUserIDinteger

The ID of the user that deleted this definition. Read only.

DeletedDatestring date-time

A timestamp of when this definition was deleted. Read only.

HashLengthinteger

The bit length of the hash data which will be used for the authorization code. Defaults to 20. May not be updated.

RandomLengthinteger

The bit length of random data which will be included in the authorization code. This is necessary to allow creation of "identical" authorization codes containing the same timestamp. Defaults to 5. May not be updated.

DurationAmountinteger

The amount of duration for the specified duration unit used to calculate the Authorization Code. Defaults to 1. May not be updated.

DurationUnits'Weeks' | 'Days' | 'Hours' | 'Minutes'

The units of duration used to calculate the Authorization Code. Defaults to 'Days'. May not be updated.

DurationAccuracyinteger

The number of bits used for timestamp verification. Defaults to 5. May not be updated.