PUT
/
o
/
{organisation_id}
/
systems
/
{system_id}
/
auth-scheme-configs
/
{auth_scheme_config_id}
curl --request PUT \
  --url https://platform.versori.com/api/v2/o/{organisation_id}/systems/{system_id}/auth-scheme-configs/{auth_scheme_config_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "none",
  "none": {
    "id": "<string>",
    "description": "<string>",
    "validationMessages": [
      {
        "text": "<string>",
        "severity": "info",
        "detail": [
          "<string>"
        ]
      }
    ]
  },
  "apiKey": {
    "id": "<string>",
    "description": "<string>",
    "validationMessages": [
      {
        "text": "<string>",
        "severity": "info",
        "detail": [
          "<string>"
        ]
      }
    ],
    "name": "<string>",
    "in": "query"
  },
  "basicAuth": {
    "id": "<string>",
    "description": "<string>",
    "validationMessages": [
      {
        "text": "<string>",
        "severity": "info",
        "detail": [
          "<string>"
        ]
      }
    ]
  },
  "oauth2": {
    "id": "<string>",
    "description": "<string>",
    "validationMessages": [
      {
        "text": "<string>",
        "severity": "info",
        "detail": [
          "<string>"
        ]
      }
    ],
    "authorizeUrl": "<string>",
    "tokenUrl": "<string>",
    "scopes": [
      {
        "name": "<string>",
        "description": "<string>"
      }
    ],
    "defaultScopes": [
      "<string>"
    ],
    "additionalAuthorizeParams": "<string>",
    "additionalTokenParams": "<string>",
    "mtlsEnabled": true,
    "mtlsCredentialId": "<string>",
    "pkce": true,
    "grant": {
      "authorizationCode": {
        "credentialId": "<string>",
        "organisationId": "<string>",
        "clientId": "<string>",
        "clientSecret": "<string>"
      },
      "clientCredentials": {},
      "password": {
        "credentialId": "<string>",
        "organisationId": "<string>",
        "clientId": "<string>",
        "clientSecret": "<string>"
      },
      "type": "authorizationCode"
    }
  },
  "oauth1": {
    "id": "<string>",
    "description": "<string>",
    "validationMessages": [
      {
        "text": "<string>",
        "severity": "info",
        "detail": [
          "<string>"
        ]
      }
    ],
    "consumerKey": "<string>",
    "consumerSecret": "<string>",
    "tempCredentialEndpoint": {
      "url": "<string>",
      "additionalParamConfigs": [
        {
          "parameterName": "<string>",
          "targetName": "<string>",
          "location": "LOCATION_IGNORE",
          "usages": "USAGE_UNKNOWN",
          "required": true,
          "modifiable": true
        }
      ],
      "parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
    },
    "resourceOwnerAuthorizationEndpoint": {
      "url": "<string>",
      "additionalParamConfigs": [
        {
          "parameterName": "<string>",
          "targetName": "<string>",
          "location": "LOCATION_IGNORE",
          "usages": "USAGE_UNKNOWN",
          "required": true,
          "modifiable": true
        }
      ],
      "parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
    },
    "tokenEndpoint": {
      "url": "<string>",
      "additionalParamConfigs": [
        {
          "parameterName": "<string>",
          "targetName": "<string>",
          "location": "LOCATION_IGNORE",
          "usages": "USAGE_UNKNOWN",
          "required": true,
          "modifiable": true
        }
      ],
      "parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
    },
    "signatureMethod": "<string>",
    "credentialId": "<string>"
  },
  "hmac": {
    "id": "<string>",
    "description": "<string>",
    "validationMessages": [
      {
        "text": "<string>",
        "severity": "info",
        "detail": [
          "<string>"
        ]
      }
    ],
    "name": "<string>",
    "in": "query",
    "algorithm": "sha1",
    "digestInputs": [
      "body"
    ]
  },
  "certificate": {
    "id": "<string>",
    "description": "<string>",
    "validationMessages": [
      {
        "text": "<string>",
        "severity": "info",
        "detail": [
          "<string>"
        ]
      }
    ]
  }
}'
{
  "type": "none",
  "none": {
    "id": "<string>",
    "description": "<string>",
    "validationMessages": [
      {
        "text": "<string>",
        "severity": "info",
        "detail": [
          "<string>"
        ]
      }
    ]
  },
  "apiKey": {
    "id": "<string>",
    "description": "<string>",
    "validationMessages": [
      {
        "text": "<string>",
        "severity": "info",
        "detail": [
          "<string>"
        ]
      }
    ],
    "name": "<string>",
    "in": "query"
  },
  "basicAuth": {
    "id": "<string>",
    "description": "<string>",
    "validationMessages": [
      {
        "text": "<string>",
        "severity": "info",
        "detail": [
          "<string>"
        ]
      }
    ]
  },
  "oauth2": {
    "id": "<string>",
    "description": "<string>",
    "validationMessages": [
      {
        "text": "<string>",
        "severity": "info",
        "detail": [
          "<string>"
        ]
      }
    ],
    "authorizeUrl": "<string>",
    "tokenUrl": "<string>",
    "scopes": [
      {
        "name": "<string>",
        "description": "<string>"
      }
    ],
    "defaultScopes": [
      "<string>"
    ],
    "additionalAuthorizeParams": "<string>",
    "additionalTokenParams": "<string>",
    "mtlsEnabled": true,
    "mtlsCredentialId": "<string>",
    "pkce": true,
    "grant": {
      "authorizationCode": {
        "credentialId": "<string>",
        "organisationId": "<string>",
        "clientId": "<string>",
        "clientSecret": "<string>"
      },
      "clientCredentials": {},
      "password": {
        "credentialId": "<string>",
        "organisationId": "<string>",
        "clientId": "<string>",
        "clientSecret": "<string>"
      },
      "type": "authorizationCode"
    }
  },
  "oauth1": {
    "id": "<string>",
    "description": "<string>",
    "validationMessages": [
      {
        "text": "<string>",
        "severity": "info",
        "detail": [
          "<string>"
        ]
      }
    ],
    "consumerKey": "<string>",
    "consumerSecret": "<string>",
    "tempCredentialEndpoint": {
      "url": "<string>",
      "additionalParamConfigs": [
        {
          "parameterName": "<string>",
          "targetName": "<string>",
          "location": "LOCATION_IGNORE",
          "usages": "USAGE_UNKNOWN",
          "required": true,
          "modifiable": true
        }
      ],
      "parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
    },
    "resourceOwnerAuthorizationEndpoint": {
      "url": "<string>",
      "additionalParamConfigs": [
        {
          "parameterName": "<string>",
          "targetName": "<string>",
          "location": "LOCATION_IGNORE",
          "usages": "USAGE_UNKNOWN",
          "required": true,
          "modifiable": true
        }
      ],
      "parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
    },
    "tokenEndpoint": {
      "url": "<string>",
      "additionalParamConfigs": [
        {
          "parameterName": "<string>",
          "targetName": "<string>",
          "location": "LOCATION_IGNORE",
          "usages": "USAGE_UNKNOWN",
          "required": true,
          "modifiable": true
        }
      ],
      "parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
    },
    "signatureMethod": "<string>",
    "credentialId": "<string>"
  },
  "hmac": {
    "id": "<string>",
    "description": "<string>",
    "validationMessages": [
      {
        "text": "<string>",
        "severity": "info",
        "detail": [
          "<string>"
        ]
      }
    ],
    "name": "<string>",
    "in": "query",
    "algorithm": "sha1",
    "digestInputs": [
      "body"
    ]
  },
  "certificate": {
    "id": "<string>",
    "description": "<string>",
    "validationMessages": [
      {
        "text": "<string>",
        "severity": "info",
        "detail": [
          "<string>"
        ]
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication used by the Versori Platform. External consumers must provide an API key, however internal consumers must provide a JWT id_token issued by our IdP.

Path Parameters

​
organisation_id
string
required
​
system_id
string
required
​
auth_scheme_config_id
string
required

Body

application/json

Response

201
application/json

Created

The response is of type object.