PUT
/
o
/
{organisation_id}
/
credentials
/
{credential_id}
curl --request PUT \
  --url https://platform.versori.com/api/connect/v1alpha1/o/{organisation_id}/credentials/{credential_id} \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "type": "none",
  "name": "<string>",
  "usages": [
    {
      "environment": {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>",
        "connection": {
          "id": "<string>",
          "organisationId": "<string>",
          "name": "<string>",
          "protocol": "http",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "errors": [
    "<string>"
  ],
  "data": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}'
{
  "id": "<string>",
  "type": "none",
  "name": "<string>",
  "usages": [
    {
      "environment": {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>",
        "connection": {
          "id": "<string>",
          "organisationId": "<string>",
          "name": "<string>",
          "protocol": "http",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "errors": [
    "<string>"
  ],
  "data": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

cookie
string
cookierequired

Cookie authentication used by the Versori Platform.

Path Parameters

organisation_id
string
required
credential_id
string
required

Body

application/json
id
string
required

ID is the unique identifier of the Credential.

type
enum<string>
required

CredentialType denotes the type of the credential which determines what the Credential's data property will contain.

  • none: No credential is required to authenticate with the Connection.
  • string: The credential is a string value, such as an API key or password.
  • binary: The credential is a binary value, such as a private key, certificate or other file.
  • basic-auth: The credential is a username and password to be used for basic authentication.
  • oauth2-client: The credential is an OAuth2 client ID and secret to be used for OAuth2 authentication.
  • oauth2-token: The credential is an OAuth2 access_token to be used for OAuth2 authentication.
Available options:
none,
string,
binary,
basic-auth,
oauth2-client,
oauth2-token
name
string
required

Name is the name of the Credential.

usages
object[]

CredentialUsages is a list of references to the Connections which are using this Credential. To aid performance, this field will only be defined for specific endpoints. An undefined property means that the usages have not been loaded, whereas an empty array indicates that the credential is not used by any connections.

errors
string[]

Errors is a list of errors which occurred when attempting to validate the credential. This field may be undefined, which implies that validation has not occurred and the consumer cannot assume whether this Credential is valid or not. An empty array indicates that the Credential is valid.

data
object
required

CredentialDataNone contains no data as no credential is required to authenticate with the Connection. It is used purely as a placeholder to implement a consistent interface across all CredentialType/AuthSchemeTypes.

createdAt
string
required

CreatedAt is the time at which the Credential was created.

updatedAt
string
required

UpdatedAt is the time at which the Credential was last updated.

Response

200 - application/json
id
string
required

ID is the unique identifier of the Credential.

type
enum<string>
required

CredentialType denotes the type of the credential which determines what the Credential's data property will contain.

  • none: No credential is required to authenticate with the Connection.
  • string: The credential is a string value, such as an API key or password.
  • binary: The credential is a binary value, such as a private key, certificate or other file.
  • basic-auth: The credential is a username and password to be used for basic authentication.
  • oauth2-client: The credential is an OAuth2 client ID and secret to be used for OAuth2 authentication.
  • oauth2-token: The credential is an OAuth2 access_token to be used for OAuth2 authentication.
Available options:
none,
string,
binary,
basic-auth,
oauth2-client,
oauth2-token
name
string
required

Name is the name of the Credential.

usages
object[]

CredentialUsages is a list of references to the Connections which are using this Credential. To aid performance, this field will only be defined for specific endpoints. An undefined property means that the usages have not been loaded, whereas an empty array indicates that the credential is not used by any connections.

errors
string[]

Errors is a list of errors which occurred when attempting to validate the credential. This field may be undefined, which implies that validation has not occurred and the consumer cannot assume whether this Credential is valid or not. An empty array indicates that the Credential is valid.

data
object
required

CredentialDataNone contains no data as no credential is required to authenticate with the Connection. It is used purely as a placeholder to implement a consistent interface across all CredentialType/AuthSchemeTypes.

createdAt
string
required

CreatedAt is the time at which the Credential was created.

updatedAt
string
required

UpdatedAt is the time at which the Credential was last updated.