List organizations

curl --request GET \
  --url https://api.example.com/api/v1/organizations \
  --header 'Authorization: Bearer <token>'

[
  {
    "metadata": {
      "id": "a142f641-7fd6-4ab9-a875-344c7ebadc53",
      "name": "acme-corp",
      "creationTime": "2024-05-31T14:11:00Z",
      "provisioningStatus": "provisioned",
      "healthStatus": "healthy"
    },
    "spec": {
      "organizationType": "domain",
      "domain": "acme.corp",
      "providerID": "b6ec241d-e3b4-4afc-a7aa-500fcb650d8e"
    }
  }
]

GET

api

organizations

List organizations

curl --request GET \
  --url https://api.example.com/api/v1/organizations \
  --header 'Authorization: Bearer <token>'

[
  {
    "metadata": {
      "id": "a142f641-7fd6-4ab9-a875-344c7ebadc53",
      "name": "acme-corp",
      "creationTime": "2024-05-31T14:11:00Z",
      "provisioningStatus": "provisioned",
      "healthStatus": "healthy"
    },
    "spec": {
      "organizationType": "domain",
      "domain": "acme.corp",
      "providerID": "b6ec241d-e3b4-4afc-a7aa-500fcb650d8e"
    }
  }
]

Authorizations

Authorization

string

header

required

Operation requires OAuth 2.0 bearer token authentication.

Query Parameters

string

A user's email address.

Response

A list of organizations.

metadata

object

required

Metadata required by all resource reads.

Show child attributes

metadata.name

string

required

A valid Kubernetes label value, typically used for resource names that can be indexed in the database.

metadata.id

string

required

The unique resource ID.

metadata.creationTime

string<date-time>

required

The time the resource was created.

metadata.provisioningStatus

enum<string>

required

The provisioning state of a resource.

Available options:

unknown,

provisioning,

provisioned,

deprovisioning,

error

metadata.healthStatus

enum<string>

required

The health state of a resource.

Available options:

unknown,

healthy,

degraded,

error

metadata.description

string

The resource description, this optionally augments the name with more context.

metadata.tags

object[]

A list of tags.

Show child attributes

metadata.tags.name

string

required

A unique tag name.

metadata.tags.value

string

required

The value of the tag.

metadata.createdBy

string

The user who created the resource.

metadata.modifiedTime

string<date-time>

The time a resource was updated.

metadata.modifiedBy

string

The user who updated the resource.

metadata.deletionTime

string<date-time>

The time the resource was deleted.

spec

object

required

An organization.

Show child attributes

spec.organizationType

enum<string>

required

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.

Available options:

adhoc,

domain

spec.domain

string<hostname>

The email domain of the organization.

spec.providerScope

enum<string>

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.

Available options:

global,

organization

spec.providerID

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.

spec.googleCustomerID

string

When set this identifies the customer ID for the google managed organization. This field is currently unused.

List file storage classes Get organization

⌘I

Serverless Inference

Fine Tuning

Compute

Networking and Storage

Organization

List organizations

Authorizations

Query Parameters

Response