Skip to main content

Modify the selected credential​

Set the content of the selected credential to be the request body. If the content or name for this credential had previously been created for your organization, it will be overwritten and cannot be retrieved. Otherwise, the new content will be set.

Path Parameters
  • cred_id string required

    ID of the credential to retrieve, modify or delete

Header Parameters
  • SlashID-OrgID string required

    The organization ID

    Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
  • SlashID-Required-Consistency string

    Possible values: [local_region, all_regions]

    Default value: local_region

    The consistency level required for this request. If the consistency level is not achieved within the timeout, the request will fail with a 408 Request Timeout error. 408 Request Timeout error indicates that request was not handled within the timeout, but it may still be handled after request timeout. Allowed values: * local_region: Wait while the request executes in the local region. * all_regions: Wait while the request executes across all regions. You can learn more about our replication model on our Cross-region Replication Model page.

  • SlashID-Required-Consistency-Timeout integer

    Possible values: >= 1 and <= 120

    Default value: 30

    The maximum amount of seconds to wait for the requested consistency level to be achieved. If the consistency level is not achieved within this time, the request will fail with a 408 Request Timeout error. 408 Request Timeout error indicates that request was not handled within the timeout, but it may still be handled after request timeout. You can learn more about our replication model on our Cross-region Replication Model page.

Request Body

The new content of the selected credential

  • external_cred_id string required

    External credential ID

  • organization_id string required
  • extcred_provider string required

    Possible values: [google, onfido, shopify, generic]

  • extcred_label string required
  • extcred_type string required

    Possible values: [api_key, client_credentials, user_pass, api_id_access, access_token, json_credentials]

  • json_blob object

    Free form object for implicit server to server authentication credentials, different schema for provider.

Responses

No content