Api Security API

Get all security-schemes of the environment

Path	Method	Protected
`/v1/envs/{environment_id}/security-schemes`	GET	Yes

Example Response JSON


{
  "values": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "revision": 0,
      "name": "string",
      "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
      "providerType": {
        "type": "Gitlab"
      },
      "clientId": "string",
      "redirectUrl": "string",
      "scopes": [
        "string"
      ]
    }
  ]
}

Create a new security scheme

Path	Method	Protected
`/v1/envs/{environment_id}/security-schemes`	POST	Yes

Example Request JSON


{
  "name": "string",
  "providerType": {
    "type": "Gitlab"
  },
  "clientId": "string",
  "clientSecret": "string",
  "redirectUrl": "string",
  "scopes": [
    "string"
  ]
}

Example Response JSON


{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "revision": 0,
  "name": "string",
  "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
  "providerType": {
    "type": "Gitlab"
  },
  "clientId": "string",
  "redirectUrl": "string",
  "scopes": [
    "string"
  ]
}

Get security scheme

Path	Method	Protected
`/v1/security-schemes/{security_scheme_id}`	GET	Yes

Example Response JSON


{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "revision": 0,
  "name": "string",
  "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
  "providerType": {
    "type": "Gitlab"
  },
  "clientId": "string",
  "redirectUrl": "string",
  "scopes": [
    "string"
  ]
}

Delete security scheme

Path	Method	Protected
`/v1/security-schemes/{security_scheme_id}`	DELETE	Yes

Query Parameters

Name	Type	Required	Description
current_revision	integer	Yes	-

Example Response JSON


{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "revision": 0,
  "name": "string",
  "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
  "providerType": {
    "type": "Gitlab"
  },
  "clientId": "string",
  "redirectUrl": "string",
  "scopes": [
    "string"
  ]
}

Update security scheme

Path	Method	Protected
`/v1/security-schemes/{security_scheme_id}`	PATCH	Yes

Example Request JSON


{
  "currentRevision": 0,
  "providerType": {
    "type": "Gitlab"
  },
  "clientId": "string",
  "clientSecret": "string",
  "redirectUrl": "string",
  "scopes": [
    "string"
  ]
}

Example Response JSON


{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "revision": 0,
  "name": "string",
  "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
  "providerType": {
    "type": "Gitlab"
  },
  "clientId": "string",
  "redirectUrl": "string",
  "scopes": [
    "string"
  ]
}

Api Security API Errors

Status Code	Description	Body
400	Invalid request, returning with a list of issues detected in the request	`{"code":"string","errors":["string"]}`
401	Unauthorized request	`{"code":"string","error":"string"}`
403	Forbidden Request	`{"code":"string","error":"string"}`
404	Entity not found	`{"code":"string","error":"string"}`
409		`{"code":"string","error":"string"}`
422	Limits of the plan exceeded	`{"code":"string","error":"string"}`
500	Internal server error	`{"code":"string","error":"string"}`