credential EntityType

Entity Set Path
[organization URI]/api/data/v9.2/credentials
Base Type
Display Name
Primary Key
Primary Key Attribute
Operations Supported


Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
componentidunique Edm.Guid

For internal use only.

Display Name: Row id unique

Read Only
componentstate Edm.Int32

For internal use only.

Display Name: Component State

Read Only
Default Options
Values Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished
connectiontype Edm.Int32

Display Name: Connection Type

Default Options
Values Label
1 UsernamePassword
2 UsernamePasswordList
3 UsernamePasswordListWithGroupMapping
4 CyberArkIdentity
createdon Edm.DateTimeOffset

Date and time when the record was created.

Display Name: Created On

Read Only
credentialid Edm.Guid

Unique identifier for entity instances

Display Name: Credential

credentials Edm.String

Display Name: Credentials

credentialtype Edm.Int32

Display Name: Credential Type

Default Options
Values Label
1 SingleCredential
2 ListOfCredentials
cyberarkapplicationid Edm.String

Display Name: CyberArk Application Id

description Edm.String

The description of the credential.

Display Name: Description

groupmapping Edm.String

Display Name: Group Mapping

importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

iscustomizable BooleanManagedProperty

For internal use only.

Display Name: Is Customizable

ismanaged Edm.Boolean

Indicates whether the solution component is part of a managed solution.

Display Name: Is Managed

Read Only
Default Options
Values Label
1 Managed
0 Unmanaged
modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display Name: Modified On

Read Only
name Edm.String

The name of the custom entity.

Display Name: Name

overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

overwritetime Edm.DateTimeOffset

For internal use only.

Display Name: Record Overwrite Time

Read Only
solutionid Edm.Guid

Unique identifier of the associated solution.

Display Name: Solution

Read Only
statecode Edm.Int32

Status of the Credential

Display Name: Status

Default Options
Values Label
0 Active
1 Inactive
statuscode Edm.Int32

Reason for the status of the Credential

Display Name: Status Reason

Default Options
Values Label
1 Active
2 Inactive
timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

versionnumber Edm.Int64

Version Number

Display Name: Version Number

Read Only

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.

Name Single-valued navigation property Description
_createdby_value createdby

Unique identifier of the user who created the record.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the record.

_cyberarkobject_value cyberarkobject
_cyberarksafe_value cyberarksafe

Metadata of the CyberArk safe where the password is stored: Hostname or IP address of the CCP endpoint, Folder and Name of the CyberArk safe where the password is stored

_cyberarkusername_value cyberarkusername
_modifiedby_value modifiedby

Unique identifier of the user who modified the record.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who modified the record.

_ownerid_value ownerid

Owner Id

_owningbusinessunit_value owningbusinessunit

Unique identifier for the business unit that owns the record

_owningteam_value owningteam

Unique identifier for the team that owns the record.

_owninguser_value owninguser

Unique identifier for the user that owns the record.

_password_value password
_username_value username

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name Type Partner
createdby systemuser lk_credential_createdby
createdonbehalfby systemuser lk_credential_createdonbehalfby
cyberarkobject environmentvariabledefinition environmentvariabledefinition_credential_cyberarkobject
cyberarksafe environmentvariabledefinition environmentvariabledefinition_credential_cyberarksafe
cyberarkusername environmentvariabledefinition environmentvariabledefinition_credential_cyberarkusername
modifiedby systemuser lk_credential_modifiedby
modifiedonbehalfby systemuser lk_credential_modifiedonbehalfby
ownerid principal owner_credential
owningbusinessunit businessunit business_unit_credential
owningteam team team_credential
owninguser systemuser user_credential
password environmentvariabledefinition environmentvariabledefinition_credential_password
username environmentvariabledefinition environmentvariabledefinition_credential_username

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name Type Partner
connectioninstance_CredentialId_credential connectioninstance CredentialId
credential_AsyncOperations asyncoperation regardingobjectid_credential
credential_BulkDeleteFailures bulkdeletefailure regardingobjectid_credential
credential_DuplicateBaseRecord duplicaterecord baserecordid_credential
credential_DuplicateMatchingRecord duplicaterecord duplicaterecordid_credential
credential_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_credential
credential_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_credential
credential_ProcessSession processsession regardingobjectid_credential
credential_SyncErrors syncerror regardingobjectid_credential


The following operations can be used with the credential entity type.

Name Binding
CreateMultiple Not Bound
GrantAccess Not Bound
IsValidStateTransition Not Bound
ListCredentialDependencies Bound to Entity
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound
UpdateMultiple Not Bound

See also