Identity API

The Identity API provides an OIDC compliant interface for use with all official and 3rd party services and proxies. As its intended use is for multi-tenant cloud deployments, it acts as an aggregation layer for other 3rd party OIDC services, dispatching login requests to the required OIDC backend. Token introspection forms the basis of role based access control across all APIs. For security purposes, access tokens and refresh tokens are limited to a single session per client, thus if they are being consumed by a horizontally scalable platform care must be taken to ensure token rotation is handled atomically by a single process, and the tokens are distributed to each service instance synchronously.
More information: https://openapi-generator.tech
Contact Info: team@openapitools.org
Version: 1.4.0
BasePath:
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. OAuth AuthorizationUrl:https://identity.nks.europe-west4.nscale.com/oauth2/v2/authorizationTokenUrl:https://identity.nks.europe-west4.nscale.com/oauth2/v2/token

Methods

[ Jump to Models ]

Table of Contents

Default

Default

Up 
get /api/v1/acl
(apiV1AclGet)
Returns access control properties for the user.

Return type

acl

Example data

Content-Type: application/json
{
  "projects" : [ {
    "endpoints" : [ {
      "operations" : [ "create", "create" ],
      "name" : "name"
    }, {
      "operations" : [ "create", "create" ],
      "name" : "name"
    } ],
    "id" : "id"
  }, {
    "endpoints" : [ {
      "operations" : [ "create", "create" ],
      "name" : "name"
    }, {
      "operations" : [ "create", "create" ],
      "name" : "name"
    } ],
    "id" : "id"
  } ],
  "organization" : {
    "endpoints" : [ {
      "operations" : [ "create", "create" ],
      "name" : "name"
    }, {
      "operations" : [ "create", "create" ],
      "name" : "name"
    } ],
    "id" : "id"
  },
  "global" : [ {
    "operations" : [ "create", "create" ],
    "name" : "name"
  }, {
    "operations" : [ "create", "create" ],
    "name" : "name"
  } ]
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A list of access controls. acl

401

Authentication failed or the access token has expired. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /api/v1/oauth2providers
(apiV1Oauth2providersGet)
Lists system identity providers.

Return type

array[oauth2ProviderRead]

Example data

Content-Type: application/json
[ {
  "metadata" : {
    "organizationId" : "organizationId",
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "clientID" : "clientID",
    "clientSecret" : "clientSecret",
    "type" : "google",
    "issuer" : "issuer"
  }
}, {
  "metadata" : {
    "organizationId" : "organizationId",
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "clientID" : "clientID",
    "clientSecret" : "clientSecret",
    "type" : "google",
    "issuer" : "issuer"
  }
} ]

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A list of system provided OAuth 2.0 providers.

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /api/v1/organizations
(apiV1OrganizationsGet)
Returns a list of organizations that the user is a member of. If an email address is provided in the query this allows a user with sufficient privilege to check if a given user is a member of any organizations.

Query parameters

email (optional)
Query Parameter — A user's email address. default: null

Return type

array[organizationRead]

Example data

Content-Type: application/json
[ {
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "organizationType" : "adhoc",
    "providerScope" : "global",
    "providerID" : "providerID",
    "googleCustomerID" : "googleCustomerID",
    "domain" : "domain"
  }
}, {
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "organizationType" : "adhoc",
    "providerScope" : "global",
    "providerID" : "providerID",
    "googleCustomerID" : "googleCustomerID",
    "domain" : "domain"
  }
} ]

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A list of organizations.

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /api/v1/organizations/{organizationID}/acl
(apiV1OrganizationsOrganizationIDAclGet)
Returns access control properties for the user.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null

Return type

acl

Example data

Content-Type: application/json
{
  "projects" : [ {
    "endpoints" : [ {
      "operations" : [ "create", "create" ],
      "name" : "name"
    }, {
      "operations" : [ "create", "create" ],
      "name" : "name"
    } ],
    "id" : "id"
  }, {
    "endpoints" : [ {
      "operations" : [ "create", "create" ],
      "name" : "name"
    }, {
      "operations" : [ "create", "create" ],
      "name" : "name"
    } ],
    "id" : "id"
  } ],
  "organization" : {
    "endpoints" : [ {
      "operations" : [ "create", "create" ],
      "name" : "name"
    }, {
      "operations" : [ "create", "create" ],
      "name" : "name"
    } ],
    "id" : "id"
  },
  "global" : [ {
    "operations" : [ "create", "create" ],
    "name" : "name"
  }, {
    "operations" : [ "create", "create" ],
    "name" : "name"
  } ]
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A list of access controls. acl

401

Authentication failed or the access token has expired. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /api/v1/organizations/{organizationID}/allocations
(apiV1OrganizationsOrganizationIDAllocationsGet)
Lists all allocation.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null

Return type

array[allocationRead]

Example data

Content-Type: application/json
[ {
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "description" : "description",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "organizationId" : "organizationId",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "modifiedBy" : "modifiedBy",
    "id" : "id",
    "projectId" : "projectId"
  },
  "spec" : {
    "allocations" : [ {
      "committed" : 0,
      "reserved" : 6,
      "kind" : "kind"
    }, {
      "committed" : 0,
      "reserved" : 6,
      "kind" : "kind"
    } ],
    "kind" : "kind",
    "id" : "id"
  }
}, {
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "description" : "description",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "organizationId" : "organizationId",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "modifiedBy" : "modifiedBy",
    "id" : "id",
    "projectId" : "projectId"
  },
  "spec" : {
    "allocations" : [ {
      "committed" : 0,
      "reserved" : 6,
      "kind" : "kind"
    }, {
      "committed" : 0,
      "reserved" : 6,
      "kind" : "kind"
    } ],
    "kind" : "kind",
    "id" : "id"
  }
} ]

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A list of allocations.

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
delete /api/v1/organizations/{organizationID}
(apiV1OrganizationsOrganizationIDDelete)
Delete an organization, all of its users, groups, projects, and infrastructure.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

Organization is being removed.

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /api/v1/organizations/{organizationID}
(apiV1OrganizationsOrganizationIDGet)
Get an organization.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null

Return type

organizationRead

Example data

Content-Type: application/json
{
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "organizationType" : "adhoc",
    "providerScope" : "global",
    "providerID" : "providerID",
    "googleCustomerID" : "googleCustomerID",
    "domain" : "domain"
  }
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

An organization. organizationRead

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /api/v1/organizations/{organizationID}/groups
(apiV1OrganizationsOrganizationIDGroupsGet)
Returns a list of groups that are defined for the organization.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null

Return type

array[groupRead]

Example data

Content-Type: application/json
[ {
  "metadata" : {
    "organizationId" : "organizationId",
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "roleIDs" : [ "roleIDs", "roleIDs" ],
    "serviceAccountIDs" : [ "serviceAccountIDs", "serviceAccountIDs" ],
    "userIDs" : [ "userIDs", "userIDs" ]
  }
}, {
  "metadata" : {
    "organizationId" : "organizationId",
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "roleIDs" : [ "roleIDs", "roleIDs" ],
    "serviceAccountIDs" : [ "serviceAccountIDs", "serviceAccountIDs" ],
    "userIDs" : [ "userIDs", "userIDs" ]
  }
} ]

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A list of groups for the organization.

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
delete /api/v1/organizations/{organizationID}/groups/{groupid}
(apiV1OrganizationsOrganizationIDGroupsGroupidDelete)
Allows the deletion of an existing group.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
groupid (required)
Path Parameter — A unique group ID. default: null

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Group successfully deleted.

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /api/v1/organizations/{organizationID}/groups/{groupid}
(apiV1OrganizationsOrganizationIDGroupsGroupidGet)
Allows a single group to be polled.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
groupid (required)
Path Parameter — A unique group ID. default: null

Return type

groupRead

Example data

Content-Type: application/json
{
  "metadata" : {
    "organizationId" : "organizationId",
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "roleIDs" : [ "roleIDs", "roleIDs" ],
    "serviceAccountIDs" : [ "serviceAccountIDs", "serviceAccountIDs" ],
    "userIDs" : [ "userIDs", "userIDs" ]
  }
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A group in the organization. groupRead

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
put /api/v1/organizations/{organizationID}/groups/{groupid}
(apiV1OrganizationsOrganizationIDGroupsGroupidPut)
Allows a group to be updated.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
groupid (required)
Path Parameter — A unique group ID. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

groupWrite groupWrite (required)
Body Parameter —

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Group successfully updated and returned.

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
post /api/v1/organizations/{organizationID}/groups
(apiV1OrganizationsOrganizationIDGroupsPost)
Allows creation of a new group.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

groupWrite groupWrite (required)
Body Parameter —

Return type

groupRead

Example data

Content-Type: application/json
{
  "metadata" : {
    "organizationId" : "organizationId",
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "roleIDs" : [ "roleIDs", "roleIDs" ],
    "serviceAccountIDs" : [ "serviceAccountIDs", "serviceAccountIDs" ],
    "userIDs" : [ "userIDs", "userIDs" ]
  }
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

A group in the organization. groupRead

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

409

Resource conflicts with another, usually this means they have the same name. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /api/v1/organizations/{organizationID}/oauth2providers
(apiV1OrganizationsOrganizationIDOauth2providersGet)
Lists an organization's identity providers.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null

Return type

array[oauth2ProviderRead]

Example data

Content-Type: application/json
[ {
  "metadata" : {
    "organizationId" : "organizationId",
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "clientID" : "clientID",
    "clientSecret" : "clientSecret",
    "type" : "google",
    "issuer" : "issuer"
  }
}, {
  "metadata" : {
    "organizationId" : "organizationId",
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "clientID" : "clientID",
    "clientSecret" : "clientSecret",
    "type" : "google",
    "issuer" : "issuer"
  }
} ]

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A list of OAuth 2.0 providers.

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
post /api/v1/organizations/{organizationID}/oauth2providers
(apiV1OrganizationsOrganizationIDOauth2providersPost)
Create an organization's identity provider.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

oauth2ProviderWrite oauth2ProviderWrite (required)
Body Parameter —

Return type

oauth2ProviderRead

Example data

Content-Type: application/json
{
  "metadata" : {
    "organizationId" : "organizationId",
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "clientID" : "clientID",
    "clientSecret" : "clientSecret",
    "type" : "google",
    "issuer" : "issuer"
  }
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

An OAuth 2.0 provider. oauth2ProviderRead

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

409

Resource conflicts with another, usually this means they have the same name. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
delete /api/v1/organizations/{organizationID}/oauth2providers/{providerID}
(apiV1OrganizationsOrganizationIDOauth2providersProviderIDDelete)
Delete an organization's identity provider.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
providerID (required)
Path Parameter — An oauth2 provider ID. default: null

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Identity provider successfully deleted.

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
put /api/v1/organizations/{organizationID}/oauth2providers/{providerID}
(apiV1OrganizationsOrganizationIDOauth2providersProviderIDPut)
Update an organization's identity provider.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
providerID (required)
Path Parameter — An oauth2 provider ID. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

oauth2ProviderWrite oauth2ProviderWrite (required)
Body Parameter —

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Organizational identity provider updated.

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /api/v1/organizations/{organizationID}/projects
(apiV1OrganizationsOrganizationIDProjectsGet)
List all projects for the organization.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null

Return type

array[projectRead]

Example data

Content-Type: application/json
[ {
  "metadata" : {
    "organizationId" : "organizationId",
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "groupIDs" : [ "groupIDs", "groupIDs" ]
  }
}, {
  "metadata" : {
    "organizationId" : "organizationId",
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "groupIDs" : [ "groupIDs", "groupIDs" ]
  }
} ]

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A list of projects.

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
post /api/v1/organizations/{organizationID}/projects
(apiV1OrganizationsOrganizationIDProjectsPost)
Creates a new project resource for the user's organization.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

projectWrite projectWrite (required)
Body Parameter —

Return type

projectRead

Example data

Content-Type: application/json
{
  "metadata" : {
    "organizationId" : "organizationId",
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "groupIDs" : [ "groupIDs", "groupIDs" ]
  }
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

A project. projectRead

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

409

Resource conflicts with another, usually this means they have the same name. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
delete /api/v1/organizations/{organizationID}/projects/{projectID}/allocations/{allocationID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDAllocationsAllocationIDDelete)
Updates an allocation.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
projectID (required)
Path Parameter — A project ID. default: null
allocationID (required)
Path Parameter — A resource allocation ID. default: null

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

Allocation successfully deleted.

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /api/v1/organizations/{organizationID}/projects/{projectID}/allocations/{allocationID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDAllocationsAllocationIDGet)
Gets an allocation.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
projectID (required)
Path Parameter — A project ID. default: null
allocationID (required)
Path Parameter — A resource allocation ID. default: null

Return type

allocationRead

Example data

Content-Type: application/json
{
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "description" : "description",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "organizationId" : "organizationId",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "modifiedBy" : "modifiedBy",
    "id" : "id",
    "projectId" : "projectId"
  },
  "spec" : {
    "allocations" : [ {
      "committed" : 0,
      "reserved" : 6,
      "kind" : "kind"
    }, {
      "committed" : 0,
      "reserved" : 6,
      "kind" : "kind"
    } ],
    "kind" : "kind",
    "id" : "id"
  }
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

An allocation. allocationRead

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
put /api/v1/organizations/{organizationID}/projects/{projectID}/allocations/{allocationID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDAllocationsAllocationIDPut)
Updates an allocation.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
projectID (required)
Path Parameter — A project ID. default: null
allocationID (required)
Path Parameter — A resource allocation ID. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

allocationWrite allocationWrite (required)
Body Parameter —

Return type

allocationRead

Example data

Content-Type: application/json
{
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "description" : "description",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "organizationId" : "organizationId",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "modifiedBy" : "modifiedBy",
    "id" : "id",
    "projectId" : "projectId"
  },
  "spec" : {
    "allocations" : [ {
      "committed" : 0,
      "reserved" : 6,
      "kind" : "kind"
    }, {
      "committed" : 0,
      "reserved" : 6,
      "kind" : "kind"
    } ],
    "kind" : "kind",
    "id" : "id"
  }
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

An allocation. allocationRead

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
post /api/v1/organizations/{organizationID}/projects/{projectID}/allocations
(apiV1OrganizationsOrganizationIDProjectsProjectIDAllocationsPost)
Creates an allocation.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
projectID (required)
Path Parameter — A project ID. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

allocationWrite allocationWrite (required)
Body Parameter —

Return type

allocationRead

Example data

Content-Type: application/json
{
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "description" : "description",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "organizationId" : "organizationId",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "modifiedBy" : "modifiedBy",
    "id" : "id",
    "projectId" : "projectId"
  },
  "spec" : {
    "allocations" : [ {
      "committed" : 0,
      "reserved" : 6,
      "kind" : "kind"
    }, {
      "committed" : 0,
      "reserved" : 6,
      "kind" : "kind"
    } ],
    "kind" : "kind",
    "id" : "id"
  }
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

An allocation. allocationRead

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

409

Resource conflicts with another, usually this means they have the same name. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
delete /api/v1/organizations/{organizationID}/projects/{projectID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDDelete)
Deletes the project associated with the authenticated user's scoped authorization token. This is a cascading operation and will delete all contained cluster managers and clusters.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
projectID (required)
Path Parameter — A project ID. default: null

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

The request has been accepted and will be fulfilled asynchronously. You may poll the resource and monitor its provisioning and health status to await completion of the operation.

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /api/v1/organizations/{organizationID}/projects/{projectID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDGet)
Gets a project.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
projectID (required)
Path Parameter — A project ID. default: null

Return type

projectRead

Example data

Content-Type: application/json
{
  "metadata" : {
    "organizationId" : "organizationId",
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "groupIDs" : [ "groupIDs", "groupIDs" ]
  }
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A project. projectRead

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
put /api/v1/organizations/{organizationID}/projects/{projectID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDPut)
Updates a project.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
projectID (required)
Path Parameter — A project ID. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

projectWrite projectWrite (required)
Body Parameter —

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Project successfully updated.

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
put /api/v1/organizations/{organizationID}
(apiV1OrganizationsOrganizationIDPut)
Update an organization.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

organizationWrite organizationWrite (required)
Body Parameter —

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Organization successfully updated and returned.

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /api/v1/organizations/{organizationID}/quotas
(apiV1OrganizationsOrganizationIDQuotasGet)
Gets quotas for the organization.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null

Return type

quotasRead

Example data

Content-Type: application/json
{
  "quotas" : [ {
    "committed" : 5,
    "default" : 2,
    "quantity" : 0,
    "reserved" : 5,
    "kind" : "kind",
    "displayName" : "displayName",
    "description" : "description",
    "used" : 6,
    "free" : 1
  }, {
    "committed" : 5,
    "default" : 2,
    "quantity" : 0,
    "reserved" : 5,
    "kind" : "kind",
    "displayName" : "displayName",
    "description" : "description",
    "used" : 6,
    "free" : 1
  } ]
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Queries the quotas for an organizational unit. quotasRead

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
put /api/v1/organizations/{organizationID}/quotas
(apiV1OrganizationsOrganizationIDQuotasPut)
Sets quotas for the organization.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

quotasWrite quotasWrite (required)
Body Parameter —

Return type

quotasRead

Example data

Content-Type: application/json
{
  "quotas" : [ {
    "committed" : 5,
    "default" : 2,
    "quantity" : 0,
    "reserved" : 5,
    "kind" : "kind",
    "displayName" : "displayName",
    "description" : "description",
    "used" : 6,
    "free" : 1
  }, {
    "committed" : 5,
    "default" : 2,
    "quantity" : 0,
    "reserved" : 5,
    "kind" : "kind",
    "displayName" : "displayName",
    "description" : "description",
    "used" : 6,
    "free" : 1
  } ]
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Queries the quotas for an organizational unit. quotasRead

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /api/v1/organizations/{organizationID}/roles
(apiV1OrganizationsOrganizationIDRolesGet)
Returns roles that can be used by the organization.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null

Return type

array[roleRead]

Example data

Content-Type: application/json
[ {
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  }
}, {
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  }
} ]

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A set of roles within the organization.

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /api/v1/organizations/{organizationID}/serviceaccounts
(apiV1OrganizationsOrganizationIDServiceaccountsGet)
Lists all service accounts.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null

Return type

array[serviceAccountRead]

Example data

Content-Type: application/json
[ {
  "metadata" : {
    "organizationId" : "organizationId",
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "groupIDs" : [ "groupIDs", "groupIDs" ]
  },
  "status" : {
    "expiry" : "2000-01-23T04:56:07.000+00:00",
    "accessToken" : "accessToken"
  }
}, {
  "metadata" : {
    "organizationId" : "organizationId",
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "groupIDs" : [ "groupIDs", "groupIDs" ]
  },
  "status" : {
    "expiry" : "2000-01-23T04:56:07.000+00:00",
    "accessToken" : "accessToken"
  }
} ]

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A list of service accounts.

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
post /api/v1/organizations/{organizationID}/serviceaccounts
(apiV1OrganizationsOrganizationIDServiceaccountsPost)
Creates a new service account and returns an access token, The returned access token can only be read once.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

serviceAccountWrite serviceAccountWrite (required)
Body Parameter —

Return type

serviceAccountCreate

Example data

Content-Type: application/json
{
  "metadata" : {
    "organizationId" : "organizationId",
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "groupIDs" : [ "groupIDs", "groupIDs" ]
  },
  "status" : {
    "expiry" : "2000-01-23T04:56:07.000+00:00",
    "accessToken" : "accessToken"
  }
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

A service account creation. serviceAccountCreate

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
delete /api/v1/organizations/{organizationID}/serviceaccounts/{serviceAccountID}
(apiV1OrganizationsOrganizationIDServiceaccountsServiceAccountIDDelete)
Removes a service account and revokes an access token.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
serviceAccountID (required)
Path Parameter — A service account ID. default: null

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Service account removed and access token revoked.

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
put /api/v1/organizations/{organizationID}/serviceaccounts/{serviceAccountID}
(apiV1OrganizationsOrganizationIDServiceaccountsServiceAccountIDPut)
Updates a service account.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
serviceAccountID (required)
Path Parameter — A service account ID. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

serviceAccountWrite serviceAccountWrite (required)
Body Parameter —

Return type

serviceAccountRead

Example data

Content-Type: application/json
{
  "metadata" : {
    "organizationId" : "organizationId",
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "groupIDs" : [ "groupIDs", "groupIDs" ]
  },
  "status" : {
    "expiry" : "2000-01-23T04:56:07.000+00:00",
    "accessToken" : "accessToken"
  }
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A service accounts. serviceAccountRead

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
post /api/v1/organizations/{organizationID}/serviceaccounts/{serviceAccountID}/rotate
(apiV1OrganizationsOrganizationIDServiceaccountsServiceAccountIDRotatePost)
Rotates a service account's access token. The returned access token can only be read once.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
serviceAccountID (required)
Path Parameter — A service account ID. default: null

Return type

serviceAccountCreate

Example data

Content-Type: application/json
{
  "metadata" : {
    "organizationId" : "organizationId",
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "groupIDs" : [ "groupIDs", "groupIDs" ]
  },
  "status" : {
    "expiry" : "2000-01-23T04:56:07.000+00:00",
    "accessToken" : "accessToken"
  }
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A service account creation. serviceAccountCreate

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /api/v1/organizations/{organizationID}/users
(apiV1OrganizationsOrganizationIDUsersGet)
Lists all users.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null

Return type

array[userRead]

Example data

Content-Type: application/json
[ {
  "metadata" : {
    "organizationId" : "organizationId",
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "subject" : "subject",
    "groupIDs" : [ "groupIDs", "groupIDs" ],
    "state" : "active"
  },
  "status" : {
    "lastActive" : "2000-01-23T04:56:07.000+00:00"
  }
}, {
  "metadata" : {
    "organizationId" : "organizationId",
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "subject" : "subject",
    "groupIDs" : [ "groupIDs", "groupIDs" ],
    "state" : "active"
  },
  "status" : {
    "lastActive" : "2000-01-23T04:56:07.000+00:00"
  }
} ]

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A list of users.

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
post /api/v1/organizations/{organizationID}/users
(apiV1OrganizationsOrganizationIDUsersPost)
Creates a new user and associates with a set of groups.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

userWrite userWrite (required)
Body Parameter —

Return type

userRead

Example data

Content-Type: application/json
{
  "metadata" : {
    "organizationId" : "organizationId",
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "subject" : "subject",
    "groupIDs" : [ "groupIDs", "groupIDs" ],
    "state" : "active"
  },
  "status" : {
    "lastActive" : "2000-01-23T04:56:07.000+00:00"
  }
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

A user. userRead

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

409

Resource conflicts with another, usually this means they have the same name. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
delete /api/v1/organizations/{organizationID}/users/{userID}
(apiV1OrganizationsOrganizationIDUsersUserIDDelete)
Deletes a user and disassociates them with all groups they are a member of.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
userID (required)
Path Parameter — A user ID. default: null

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

User removed and all groups disassociated with the user.

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
put /api/v1/organizations/{organizationID}/users/{userID}
(apiV1OrganizationsOrganizationIDUsersUserIDPut)
Updates a user.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
userID (required)
Path Parameter — A user ID. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

userWrite userWrite (required)
Body Parameter —

Return type

userRead

Example data

Content-Type: application/json
{
  "metadata" : {
    "organizationId" : "organizationId",
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "subject" : "subject",
    "groupIDs" : [ "groupIDs", "groupIDs" ],
    "state" : "active"
  },
  "status" : {
    "lastActive" : "2000-01-23T04:56:07.000+00:00"
  }
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A user. userRead

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
post /api/v1/organizations
(apiV1OrganizationsPost)
Allows creation of a new organization.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

organizationWrite organizationWrite (required)
Body Parameter —

Return type

organizationRead

Example data

Content-Type: application/json
{
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "organizationType" : "adhoc",
    "providerScope" : "global",
    "providerID" : "providerID",
    "googleCustomerID" : "googleCustomerID",
    "domain" : "domain"
  }
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

An organization. organizationRead

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /api/v1/signup
(apiV1SignupGet)
Complete the user signup process.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

302

A redirect to the UI.

400

A dialog to explain a signup error.
Up 
get /oauth2/v2/authorization
(oauth2V2AuthorizationGet)
Provides authentication and authorization as per the OAuth 2.0 specification. You may specify the "openid" scope in order to have an OpenID Connect identity token returned during code exchange.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A login form to request federation data from the user.

302

A redirect back to the validated callback URL.

400

A generic HTML error page.

500

A generic HTML error page.
Up 
post /oauth2/v2/authorization
(oauth2V2AuthorizationPost)
Provides authentication and authorization as per the OAuth 2.0 specification. You may specify the "openid" scope in order to have an OpenID Connect identity token returned during code exchange.

Consumes

This API call consumes the following media types via the Content-Type request header:

Form parameters

response_type (required)
Form Parameter — default: null
client_id (required)
Form Parameter — The client identifier. default: null
redirect_uri (required)
Form Parameter — The registered callback address. default: null
scope (optional)
Form Parameter — Authorization scope. default: null
state (optional)
Form Parameter — Client state information. default: null
nonce (optional)
Form Parameter — OIDC nonce. default: null
max_age (optional)
Form Parameter — Max age of the login. default: null
display (optional)
Form Parameter — How to display the login prompt. default: null
prompt (optional)
Form Parameter — OIDC prompt. default: null
ui_locales (optional)
Form Parameter — Language options. default: null
id_token_hint (optional)
Form Parameter — A previously issued ID token. default: null
login_hint (optional)
Form Parameter — A login hint e.g. user name. default: null
acr_values (optional)
Form Parameter — Requested content class reference values. default: null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A login form to request federation data from the user.

302

A redirect back to the validated callback URL.

400

A generic HTML error page.

500

A generic HTML error page.
Up 
get /oauth2/v2/jwks
(oauth2V2JwksGet)
Returns an array of public keys used to verify JWT ID tokens issued by this server.

Return type

jsonWebKeySet

Example data

Content-Type: application/json
{
  "keys" : [ [ "{}", "{}" ], [ "{}", "{}" ] ]
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A JSON web key set. This is a set of named public keys that are referenced by JSON web tokens. The public key can be used to verify that a token was signed by this service. jsonWebKeySet

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
post /oauth2/v2/login
(oauth2V2LoginPost)
Returns the user's email address, or chosen OAuth 2.0 provider back to the identity service to initiate the backend authentication and token exchange.

Consumes

This API call consumes the following media types via the Content-Type request header:

Form parameters

email (optional)
Form Parameter — The user's email address. default: null
provider (optional)
Form Parameter — The explicit provider type. default: null
state (required)
Form Parameter — The state string supplied by the authorization endpoint. default: null

Responses

302

A redirect to the specified identity provider URI.
Up 
post /oauth2/v2/onboard
(oauth2V2OnboardPost)
Returns the user's chosen organization name back to the identity service for creation of that organization, default user groups, and addition of that user to a group to allow login.

Consumes

This API call consumes the following media types via the Content-Type request header:

Form parameters

state (required)
Form Parameter — Server provided state. default: null
organization_name (required)
Form Parameter — The organization name. default: null
organization_description (optional)
Form Parameter — A verbose organization description. default: null
group_name (required)
Form Parameter — An initial group name, default: null
group_description (optional)
Form Parameter — A verbose initial group description. default: null
roles (optional)
Form Parameter — A list of roles to grant the user. default: null

Responses

302

A redirect to the specified identity provider URI.
Up 
post /oauth2/v2/token
(oauth2V2TokenPost)
Provides authorization code to access token exchange as per the OAuth 2.0 specification with the "authorization_code" grant. If requested during authentication, an OpenID Connect identity token will also be returned.
This endpoint also supports the "refresh_token" grant for transparent re-authentication, and the "client_credentials" grant which is used by other services, in conjunction with X.509 client certificates, to authenticate and authorize their API access requirements.

Consumes

This API call consumes the following media types via the Content-Type request header:

Form parameters

grant_type (required)
Form Parameter — Supported grant type. Must be either "code", "refresh_token" or "client_credentials". default: null
code (optional)
Form Parameter — Authorization code. Required with the "code" grant type. default: null
client_id (optional)
Form Parameter — Client ID. Required with the "code" and "refresh_token" grant types. default: null
client_secret (optional)
Form Parameter — Client secret. Required with the "code" and "refresh_token" grant types. default: null
redirect_uri (optional)
Form Parameter — Client redirect URI. Required with the "code" grant type. default: null
code_verifier (optional)
Form Parameter — Client code verifier. default: null
refresh_token (optional)
Form Parameter — A refresh token for the "refresh_token" grant type. default: null

Return type

token

Example data

Content-Type: application/json
{
  "access_token" : "access_token",
  "refresh_token" : "refresh_token",
  "id_token" : "id_token",
  "token_type" : "token_type",
  "expires_in" : 0
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Authentication was successful and returns an authorization token. The response may optionally include an OIDC identity token if that scope was requested. token

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /oauth2/v2/userinfo
(oauth2V2UserinfoGet)
Returns introspection information about an access token.

Return type

userinfo

Example data

Content-Type: application/json
{
  "sub" : "sub",
  "website" : "website",
  "zoneinfo" : "zoneinfo",
  "email_verified" : true,
  "birthdate" : "2000-01-23T04:56:07.000+00:00",
  "gender" : "gender",
  "profile" : "profile",
  "preferred_username" : "preferred_username",
  "given_name" : "given_name",
  "middle_name" : "middle_name",
  "locale" : "locale",
  "picture" : "picture",
  "updated_at" : "updated_at",
  "name" : "name",
  "nickname" : "nickname",
  "family_name" : "family_name",
  "email" : "email"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Information about the user from the access token. userinfo

401

Authentication failed or the access token has expired. error
Up 
post /oauth2/v2/userinfo
(oauth2V2UserinfoPost)
Returns introspection information about an access token.

Consumes

This API call consumes the following media types via the Content-Type request header:

Form parameters

access_token (optional)
Form Parameter — The oauth2 access token. default: null

Return type

userinfo

Example data

Content-Type: application/json
{
  "sub" : "sub",
  "website" : "website",
  "zoneinfo" : "zoneinfo",
  "email_verified" : true,
  "birthdate" : "2000-01-23T04:56:07.000+00:00",
  "gender" : "gender",
  "profile" : "profile",
  "preferred_username" : "preferred_username",
  "given_name" : "given_name",
  "middle_name" : "middle_name",
  "locale" : "locale",
  "picture" : "picture",
  "updated_at" : "updated_at",
  "name" : "name",
  "nickname" : "nickname",
  "family_name" : "family_name",
  "email" : "email"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Information about the user from the access token. userinfo

401

Authentication failed or the access token has expired. error
Up 
get /oidc/callback
(oidcCallbackGet)
The Identity Service OAuth 2.0 implementation does not provide any direct authentication. It instead delegates to a 3rd party identity provider. This endpoint allows a 3rd party authorization code to be returned to the Identity Service and exchanged for an identity token.

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

302

A redirect back to the browser with an authorization code.

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /.well-known/openid-configuration
(wellKnownOpenidConfigurationGet)
Reads the OIDC discovery page identifying all the required endpoints, and supported algorithms.

Return type

openidConfiguration

Example data

Content-Type: application/json
{
  "response_types_supported" : [ "code", "code" ],
  "request_parameter_supported" : true,
  "request_uri_parameter_supported" : true,
  "claims_parameter_supported" : true,
  "grant_types_supported" : [ "authorization_code", "authorization_code" ],
  "scopes_supported" : [ "openid", "openid" ],
  "issuer" : "issuer",
  "authorization_endpoint" : "https://openapi-generator.tech",
  "userinfo_endpoint" : "https://openapi-generator.tech",
  "claims_supported" : [ "aud", "aud" ],
  "code_challenge_methods_supported" : [ "S256", "S256" ],
  "jwks_uri" : "https://openapi-generator.tech",
  "id_token_signing_alg_values_supported" : [ "ES512", "ES512" ],
  "token_endpoint_auth_methods_supported" : [ "client_secret_post", "client_secret_post" ],
  "response_modes_supported" : [ "query", "query" ],
  "token_endpoint" : "https://openapi-generator.tech"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OpenID configuration used for auto-discovery of endpoints and supported algorithms and features. openidConfiguration

Models

[ Jump to Methods ]

Table of Contents

  1. acl -
  2. aclEndpoint -
  3. aclOperation -
  4. aclScopedEndpoints -
  5. allocationRead -
  6. allocationSpec -
  7. allocationWrite -
  8. authMethod -
  9. claim -
  10. codeChallengeMethod -
  11. error -
  12. grantType -
  13. groupRead -
  14. groupSpec -
  15. groupWrite -
  16. jsonWebKeySet -
  17. oauth2ProviderRead -
  18. oauth2ProviderSpec -
  19. oauth2ProviderType -
  20. oauth2ProviderWrite -
  21. openidConfiguration -
  22. organizationRead -
  23. organizationScopedResourceReadMetadata -
  24. organizationSpec -
  25. organizationType -
  26. organizationWrite -
  27. projectRead -
  28. projectScopedResourceReadMetadata -
  29. projectSpec -
  30. projectWrite -
  31. providerScope -
  32. quotaRead -
  33. quotaWrite -
  34. quotasRead -
  35. quotasWrite -
  36. resourceAllocation -
  37. resourceHealthStatus -
  38. resourceMetadata -
  39. resourceProvisioningStatus -
  40. resourceReadMetadata -
  41. resourceWriteMetadata -
  42. responseMode -
  43. responseType -
  44. roleRead -
  45. scope -
  46. serviceAccountCreate -
  47. serviceAccountRead -
  48. serviceAccountSpec -
  49. serviceAccountStatus -
  50. serviceAccountWrite -
  51. signingAlgorithm -
  52. staticResourceMetadata -
  53. systemOauth2ProviderRead -
  54. tag -
  55. token -
  56. userRead -
  57. userSpec -
  58. userState -
  59. userStatus -
  60. userWrite -
  61. userinfo -

acl - Up

A list of access control scopes and permissions.
global (optional)
array[aclEndpoint] A list of access control scopes.
organization (optional)
aclScopedEndpoints
projects (optional)
array[aclScopedEndpoints] A list of resource scoped endpoint permissions.

aclEndpoint - Up

A set of access control permissions for a resource type.
name
String The resource name
operations
array[aclOperation] A list of access control operations.

aclOperation - Up

An access control operation.

aclScopedEndpoints - Up

Resource scoped endpoint permissions.
id
String The resource ID this scope applies to.
endpoints
array[aclEndpoint] A list of access control scopes.

allocationRead - Up

An allocation of resources.
metadata
projectScopedResourceReadMetadata
spec
allocationSpec

allocationSpec - Up

A set of resource allocations.
kind
String The resource kind that owns this allocation.
id
String The resource ID that owns this allocation.
allocations
array[resourceAllocation] A list of quotas.

allocationWrite - Up

An allocation of resources.
metadata
resourceWriteMetadata
spec
allocationSpec

authMethod - Up

Supported authentication methods.

claim - Up

Supported claims.

codeChallengeMethod - Up

Supported code challenge methods.

error - Up

Generic error message, compatible with oauth2.
error
String A terse error string expanding on the HTTP error code. Errors are based on the OAuth 2.02 specification, but are expanded with proprietary status codes for APIs other than those specified by OAuth 2.02.
Enum:
invalid_request
unauthorized_client
access_denied
unsupported_response_type
invalid_scope
server_error
temporarily_unavailable
invalid_client
invalid_grant
unsupported_grant_type
not_found
conflict
method_not_allowed
unsupported_media_type
forbidden
error_description
String Verbose message describing the error.

grantType - Up

Supported grant type.

groupRead - Up

A group when read.
metadata
organizationScopedResourceReadMetadata
spec
groupSpec

groupSpec - Up

A group.
userIDs
array[String] A list of strings.
serviceAccountIDs
array[String] A list of strings.
roleIDs
array[String] A list of strings.

groupWrite - Up

A group when created or updated.
metadata
resourceWriteMetadata
spec
groupSpec

jsonWebKeySet - Up

JSON web key set. This data type is defined by an external 3rd party standards committee. Consult the relevant documentation for further details.
keys (optional)
array[List]

oauth2ProviderRead - Up

An OAuth 2.0 provider when read.
metadata
organizationScopedResourceReadMetadata
spec
oauth2ProviderSpec

oauth2ProviderSpec - Up

An OAuth 2.0 provider.
type (optional)
oauth2ProviderType
issuer
String The OIDC issuer, typically where to perform auto discovery relative to.
clientID
String The client identification.
clientSecret (optional)
String The client secret.

oauth2ProviderType - Up

The type of identity provider.

oauth2ProviderWrite - Up

An OAuth 2.0 provider when created or updated.
metadata
resourceWriteMetadata
spec
oauth2ProviderSpec

openidConfiguration - Up

OpenID configuration.
issuer
String The OpenID Issuer (iss field).
authorization_endpoint
URI The OAuth 2.0 endpoint that initiates authentication. format: uri
token_endpoint
URI The OAuth 2.0 endpoint that is used to exchange an authentication code for tokens. format: uri
userinfo_endpoint
URI The OIDC endpoint used to get information about an access token's user. format: uri
jwks_uri
URI The endpoint that exposes public signing keys for token validation. format: uri
scopes_supported
array[scope] A list of supported OAuth 2.0 scopes.
claims_supported
array[claim] A list of supported claims
response_types_supported
array[responseType] A list of supported response types that can be requested for the authorization endpoint.
response_modes_supported
array[responseMode] A list of supported response modes.
token_endpoint_auth_methods_supported
array[authMethod] A list of supported authentication methods for the token endpoint.
grant_types_supported
array[grantType] A list of supported grants for the token endpoint.
id_token_signing_alg_values_supported
array[signingAlgorithm] A list of signing algorithms supported for ID tokens.
code_challenge_methods_supported
array[codeChallengeMethod] A list of code challenge methods supported.
claims_parameter_supported
Boolean Whether claims can be requested individually.
request_parameter_supported
Boolean Whether requests can be passed as a JWT object.
request_uri_parameter_supported
Boolean Whether requests can be passed via a URI.

organizationRead - Up

An organization when read.
metadata
resourceReadMetadata
spec
organizationSpec

organizationScopedResourceReadMetadata - Up

Metadata required by organization scoped resource reads.
name
String A valid Kubernetes label value, typically used for resource names that can be indexed in the database.
description (optional)
String The resource description, this optionally augments the name with more context.
tags (optional)
array[tag] A list of tags.
id
String The unique resource ID.
creationTime
Date The time the resource was created. format: date-time
createdBy (optional)
String The user who created the resource.
modifiedTime (optional)
Date The time a resource was updated. format: date-time
modifiedBy (optional)
String The user who updated the resource.
deletionTime (optional)
Date The time the resource was deleted. format: date-time
provisioningStatus
resourceProvisioningStatus
healthStatus
resourceHealthStatus
organizationId
String The organization identifier the resource belongs to.

organizationSpec - Up

An organization.
organizationType
organizationType
domain (optional)
String The email domain of the organization. format: hostname
providerScope (optional)
providerScope
providerID (optional)
String The ID of the provider to use, the scope is determined by useCustomProvider. If false, this refers to a built in provider, if true, then to an organization specific one.
googleCustomerID (optional)
String When set this identifies the customer ID for the google managed organization. This field is currently unused.

organizationType - Up

Describes the authentication method of the organization. Ad hoc authentication means that users are exclusively added via explicit group membership And must use a 'sign-in via' option. Domain authentication means that users may login via their email address, must in the case of custom identity providers, that maps from domain to an identity provider.

organizationWrite - Up

An organization when created or updated.
metadata
resourceWriteMetadata
spec
organizationSpec

projectRead - Up

A project when read.
metadata
organizationScopedResourceReadMetadata
spec
projectSpec

projectScopedResourceReadMetadata - Up

Metadata required by project scoped resource reads.
name
String A valid Kubernetes label value, typically used for resource names that can be indexed in the database.
description (optional)
String The resource description, this optionally augments the name with more context.
tags (optional)
array[tag] A list of tags.
id
String The unique resource ID.
creationTime
Date The time the resource was created. format: date-time
createdBy (optional)
String The user who created the resource.
modifiedTime (optional)
Date The time a resource was updated. format: date-time
modifiedBy (optional)
String The user who updated the resource.
deletionTime (optional)
Date The time the resource was deleted. format: date-time
provisioningStatus
resourceProvisioningStatus
healthStatus
resourceHealthStatus
organizationId
String The organization identifier the resource belongs to.
projectId
String The project identifier the resource belongs to.

projectSpec - Up

A project.
groupIDs
array[String] A list of group IDs.

projectWrite - Up

A project when created or updated.
metadata
resourceWriteMetadata
spec
projectSpec

providerScope - Up

Describes how to lookup the provider, when "global", use a built in generic provider e.g. Google/Microsoft, when "organization", use an organization scoped provider.

quotaRead - Up

A single quota.
kind
String The kind of resource.
quantity
Integer The maximum amount of that resource.
used
Integer The amount of that resource that is used.
free
Integer The amount of that resource that is free.
committed
Integer The amount of that resource always in use.
reserved
Integer The amount of that resource that may be used e.g. autoscaled.
displayName
String The name that should be displayed to end users.
description
String A verbose explanation of what the quota limits.
default
Integer The default value of the quota.

quotaWrite - Up

A single quota.
kind
String The kind of resource.
quantity
Integer The maximum amount of that resource.

quotasRead - Up

A list of quotas.
quotas
array[quotaRead] A list of quotas.

quotasWrite - Up

A list of quotas.
quotas
array[quotaWrite] A list of quotas.

resourceAllocation - Up

A single quota but taking into account dynamic allocation.
kind
String The kind of resource.
committed
Integer The amount of that resource always in use.
reserved
Integer The amount of that resource that may be used e.g. autoscaled.

resourceHealthStatus - Up

The health state of a resource.

resourceMetadata - Up

Metadata required for all API resource reads and writes.
name
String A valid Kubernetes label value, typically used for resource names that can be indexed in the database.
description (optional)
String The resource description, this optionally augments the name with more context.
tags (optional)
array[tag] A list of tags.

resourceProvisioningStatus - Up

The provisioning state of a resource.

resourceReadMetadata - Up

Metadata required by all resource reads.
name
String A valid Kubernetes label value, typically used for resource names that can be indexed in the database.
description (optional)
String The resource description, this optionally augments the name with more context.
tags (optional)
array[tag] A list of tags.
id
String The unique resource ID.
creationTime
Date The time the resource was created. format: date-time
createdBy (optional)
String The user who created the resource.
modifiedTime (optional)
Date The time a resource was updated. format: date-time
modifiedBy (optional)
String The user who updated the resource.
deletionTime (optional)
Date The time the resource was deleted. format: date-time
provisioningStatus
resourceProvisioningStatus
healthStatus
resourceHealthStatus

resourceWriteMetadata - Up

Metadata required for all API resource reads and writes.
name
String A valid Kubernetes label value, typically used for resource names that can be indexed in the database.
description (optional)
String The resource description, this optionally augments the name with more context.
tags (optional)
array[tag] A list of tags.

responseMode - Up

Supported response modes.

responseType - Up

Supported response types.

roleRead - Up

A role.
metadata
resourceReadMetadata

scope - Up

Supported scopes.

serviceAccountCreate - Up

A new service account.
metadata
organizationScopedResourceReadMetadata
spec
serviceAccountSpec
status
serviceAccountStatus

serviceAccountRead - Up

A service account.
metadata
organizationScopedResourceReadMetadata
spec
serviceAccountSpec
status
serviceAccountStatus

serviceAccountSpec - Up

A service account specification.
groupIDs
array[String] A list of group IDs.

serviceAccountStatus - Up

A service account status.
expiry
Date When the service token is due to expire. format: date-time
accessToken (optional)
String A long lived access token that can be exchanged for an API access token.

serviceAccountWrite - Up

A service account creation request.
metadata
resourceWriteMetadata
spec
serviceAccountSpec

signingAlgorithm - Up

Supported signing algorithms.

staticResourceMetadata - Up

This metadata is for resources that just exist, and don't require any provisioning and health status, but benefit from a standardized metadata format.
name
String A valid Kubernetes label value, typically used for resource names that can be indexed in the database.
description (optional)
String The resource description, this optionally augments the name with more context.
tags (optional)
array[tag] A list of tags.
id
String The unique resource ID.
creationTime
Date The time the resource was created. format: date-time
createdBy (optional)
String The user who created the resource.
modifiedTime (optional)
Date The time a resource was updated. format: date-time
modifiedBy (optional)
String The user who updated the resource.

systemOauth2ProviderRead - Up

An OAuth 2.0 provider when read.
metadata
resourceReadMetadata
spec
oauth2ProviderSpec

tag - Up

A tag mapping arbitrary names to values. These have no special meaning for any component are are intended for use by end users to add additional context to a resource, for example to categorize it.
name
String A unique tag name.
value
String The value of the tag.

token - Up

OAuth 2.0 token result.
token_type
String How the access token is to be presented to the resource server.
access_token
String The opaque access token.
refresh_token (optional)
String The opaque refresh token.
id_token (optional)
String An OIDC ID token.
expires_in
Integer The time in seconds the token will last for.

userRead - Up

A user read object.
metadata
organizationScopedResourceReadMetadata
spec
userSpec
status
userStatus

userSpec - Up

A user specification.
subject
String The user's canonical name, usually an email address.
state
userState
groupIDs
array[String] A list of group IDs.

userState - Up

The state a user is in.

userStatus - Up

Additional user metadata.
lastActive (optional)
Date The last time a user performed some action. This is not guaranteed to be completely accurate depending on performance constraints. format: date-time

userWrite - Up

A user create/update object.
metadata (optional)
resourceWriteMetadata
spec
userSpec

userinfo - Up

Access token introspection data.
sub
String The access token's subject.
email (optional)
String The user's email address.
email_verified (optional)
Boolean Whether the email address has been verified.
name (optional)
String The user's full name.
given_name (optional)
String The user's forename.
family_name (optional)
String The user's surname.
middle_name (optional)
String The user's middle name(s).
nickname (optional)
String The user's nickname.
preferred_username (optional)
String How the user chooses to be addressed.
profile (optional)
String URL to the user's profile page.
picture (optional)
String URL to the user's picture.
website (optional)
String URL to the user's website.
gender (optional)
String The user's gender.
birthdate (optional)
Date The users' birth date formatted according to ISO8601. The year portion may be 0000 if they choose not to reveal they are really old. format: date-time
zoneinfo (optional)
String The user's IANA assigned timezone.
locale (optional)
String The user's RFC5646 language tag.
updated_at (optional)
String Then the user's profile was last updated.