Skip to main content

Credential

Properties​

NameTypeDescriptionNotes
IdStringSystem-generated unique ID of the Object[optional] [readonly]
NameStringName of the Object[required]
CreatedSystem.DateTimeCreation date of the Object[optional] [readonly]
ModifiedSystem.DateTimeLast modification date of the Object[optional] [readonly]
DescriptionStringDescription of the credential.[optional]
StatusStringThe credential status reported by the source.[optional]
NativeIdentityStringThe credential's unique identifier on the source.[optional]
EnvironmentStringThe environment the credential belongs to.[optional]
SourceCredentialAllOfSource[optional]
ResourceCredentialResource[optional]
DatasetIdStringThe ID of the source dataset the credential was retrieved from.[optional]
TypeStringThe credential type.[optional]
ScopeStringThe scope the source reports for the credential.[optional]
ExpiresAtSystem.DateTimeThe date and time the credential expires.[optional]
LastUsedAtSystem.DateTimeThe date and time the credential was last used.[optional]
OwnersCredentialOwners[optional]
Attributesmap[string]AnyTypeA map of curated credential attributes.[optional]
ConnectorAttributesmap[string]AnyTypeA map of attributes sourced from the connector during aggregation.[optional]
ManuallyEditedBooleanIndicates if the credential has been manually edited.[optional] [default to $false]

Examples​

  • Prepare the resource
$Credential = Initialize-Credential -Id id12345 `
-Name aName `
-Created 2015-05-28T14:07:17Z `
-Modified 2015-05-28T14:07:17Z `
-Description Key used by the nightly export job `
-Status Active `
-NativeIdentity AKIAIOSFODNN7EXAMPLE `
-Environment production `
-Source null `
-Resource null `
-DatasetId 8886e5e3-63d0-462f-a195-d98da885b8dc `
-Type ACCESS_KEY `
-Scope read-write `
-ExpiresAt 2026-12-31T23:59:59Z `
-LastUsedAt 2026-10-20T08:15Z `
-Owners null `
-Attributes {"status":"Active"} `
-ConnectorAttributes {"keyId":"AKIAIOSFODNN7EXAMPLE"} `
-ManuallyEdited true
  • Convert the resource to JSON
$Credential | ConvertTo-JSON

[Back to top]