credential

Returns the specified Credential object.

Access is permitted when any of the following condition(s) are met: 1. The signed-in User has any of the following permissions for the associated Organization: [org_manage_integrations, org_view_integrations]. 2. The signed-in User has any of the following permissions for the associated Organization: [org_manage_customers, org_view_customers, org_manage_integrations, org_view_integrations]. 3. The signed-in User has any of the following permissions for the object's 'customer' attribute: [customer_view, customer_edit, customer_remove, customer_admin_users, customer_view_users, customer_admin_instance_permissions, customer_view_instances].

Input fields

ArgumentTypeDescription
idID!The ID of the Credential object.

Return fields (Credential)

id (ID!)

The ID of the object.

org (Organization)

The Organization the Credential belongs to, if any. If NULL then Customer will be specified.

customer (Customer)

The Customer the Credential belongs to, if any. If NULL then Organization will be specified.

label (String!)

The name of the Credential.

authorizationMethod (AuthorizationMethod!)

The specific AuthorizationMethod used by the Credential.

readyForUse (Boolean!)

Specifies whether the Credential is ready for use by an Instance.

refreshAt (DateTime)

The timestamp at which the OAuth2 token will automatically be refreshed, if necessary. Only applies to OAuth2 methods where refresh is necessary.

authorizationError (String!)

Contains any error message generated by the external authorizing system that occurred during authorization.

values ([CredentialFieldValue])

A list of CredentialFieldValues that contain the values for the CredentialFields.

token (SafeJSONString)

Contains OAuth2 token data if applicable.

context (SafeJSONString)

Contains OAuth2 context data if applicable.

redirectUri (String)

Contains the OAuth2 Redirect URI if applicable.

allowUpdate (Boolean!)

Specifies whether the signed-in User can update the Credential.

allowRemove (Boolean!)

Specifies whether the signed-in User can remove the Credential.

Last updated on