Credentials

patch

https://app.financekey.com/OData/Credentials({key})

Defines a set of credentials used inside the application.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

name

string

required

length ≥ 1

Name of data type nvarchar in the Credential table is a variable-length data type that can store up to 4,000 characters and is used to store the username associated with each individual's credentials.

userName

string | null

The UserName field is of data type nvarchar in the credential table and stores the unique identifier for a user to use when logging in to the system.

comment

string | null

Miscellaneous notes and information for the entry or record.

password

string | null

The Password field in the Credential table stores an encrypted string value representing a user's account password. The nvarchar data type allows for the storage of up to 4000 characters.

expiry

date-time | null

Expiry of type datetime2 in the Credential table is used to track when a user's credentials expire, such as a password, token, or key. The field stores an ISO 8601 compliant date-time value in the format of 'yyyy-mm-dd hh:mm:ss'.

storageId

int32 | null

StorageId is an integer data type field of the Credential table that holds a unique identifier that relates to the storage type the credential is associated with.

credentialTypeId

string

required

length between 1 and 32

CredentialTypeId is a varchar field in the Credential table with a maximum length of 32 which defines the type of credential that a user is assigned. The possible values range from a numerical value that is up to 32 characters long, such as '1', '2', '4', etc., or a shorter value, such as 'admin', 'user', or 'guest'.

managed

boolean

The Managed field in the Credential table is a bit data type which indicates whether a credential is actively managed and subject to certain characteristic requirements. A value of '1' indicates that the credential is actively managed, and a value of '0' indicates that it is not managed.

syncStrategyId

string

required

length between 1 and 450

Determines if the Credential should by synchronised to the client tenants or not.

Response

200

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here!