Skip to content
CantoraAPI documentation
POST
/v1/organizations/{organizationId}/projects/{projectId}/environments/{environmentId}/service-principals

Create an Environment-scoped ServicePrincipal

Create a named machine identity whose immutable structural scope is this Environment.

Authentication

Send an API key as a Bearer token in the Authorization header.

Parameters

NameLocationRequiredDescription
organizationIdpathYes
The Organization to address.
stringA Cantora Organization identifier, prefixed with `org_`.
  • maximum length 64
  • pattern ^org_[\s\S]+$
projectIdpathYes
The Project to address.
stringA Cantora Project identifier, prefixed with `proj_`.
  • maximum length 64
  • pattern ^proj_[\s\S]+$
environmentIdpathYes
The Environment to address.
stringA Cantora Environment identifier, prefixed with `env_`.
  • maximum length 64
  • pattern ^env_[\s\S]+$

Request body

Required.

application/json
object
  • unknown properties allowed false
displayNamerequired
stringThe human-readable name for this machine identity.
  • maximum length 200
  • minimum length 1

Responses

201ServicePrincipalCreated
application/json
ServicePrincipalCreatedEncoded
400The request path, headers, query, or JSON body did not satisfy the published schema
401Unauthorized
application/json
UnauthorizedEncoded
403Forbidden
application/json
ForbiddenEncoded
404NotFound
application/json
NotFoundEncoded

Reusable schemas

ServicePrincipalCreatedEncoded

object
  • unknown properties allowed false
principalIdrequired
stringThe Principal identifier.
  • maximum length 64
  • pattern ^principal_[\s\S]+$
kindrequired
stringThe Principal kind.
  • allowed values "servicePrincipal"
displayNamerequired
stringThe human-readable resource name.
scoperequired
ServicePrincipalScopeThe immutable structural scope of this machine identity.
statusrequired
PrincipalStatusThe current lifecycle status.
createdAtrequired
stringWhen the resource was created, in UTC.
  • format date-time
updatedAtrequired
stringWhen the resource was last updated, in UTC.
  • format date-time

UnauthorizedEncoded

object
  • unknown properties allowed false
_tagrequired
stringThe stable machine-readable error type.
  • allowed values "Unauthorized"
reasonrequired
stringA safe explanation of why the credential was rejected.

ForbiddenEncoded

object
  • unknown properties allowed false
_tagrequired
stringThe stable machine-readable error type.
  • allowed values "Forbidden"
permissionrequired
stringThe permission required by the refused operation.

NotFoundEncoded

object
  • unknown properties allowed false
_tagrequired
stringThe stable machine-readable error type.
  • allowed values "NotFound"
resourcerequired
stringThe resource type relevant to the error.
idrequired
stringThe identifier supplied for the resource that was not found.

ServicePrincipalScope

Any of
OrganizationScope
ProjectScope
EnvironmentScope

PrincipalStatus

string
  • allowed values "active", "disabled"

OrganizationScope

object
  • unknown properties allowed false
levelrequired
stringThe tenancy level of this structural scope.
  • allowed values "organization"
organizationIdrequired
stringThe Organization identifier.
  • maximum length 64
  • pattern ^org_[\s\S]+$

ProjectScope

object
  • unknown properties allowed false
levelrequired
stringThe tenancy level of this structural scope.
  • allowed values "project"
organizationIdrequired
stringThe Organization identifier.
  • maximum length 64
  • pattern ^org_[\s\S]+$
projectIdrequired
stringThe Project identifier.
  • maximum length 64
  • pattern ^proj_[\s\S]+$

EnvironmentScope

object
  • unknown properties allowed false
levelrequired
stringThe tenancy level of this structural scope.
  • allowed values "environment"
organizationIdrequired
stringThe Organization identifier.
  • maximum length 64
  • pattern ^org_[\s\S]+$
projectIdrequired
stringThe Project identifier.
  • maximum length 64
  • pattern ^proj_[\s\S]+$
environmentIdrequired
stringThe Environment identifier.
  • maximum length 64
  • pattern ^env_[\s\S]+$