curl --request GET \
--url https://api.example.com/api/v1/organizations/{organizationID} \
--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 an organization.
curl --request GET \
--url https://api.example.com/api/v1/organizations/{organizationID} \
--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"
}
}Operation requires OAuth 2.0 bearer token authentication.
An organization ID.
An organization.
An organization when read.
Metadata required by all resource reads.
Show child attributes
A valid Kubernetes label value, typically used for resource names that can be indexed in the database.
The unique resource ID.
The time the resource was created.
The provisioning state of a resource.
unknown, provisioning, provisioned, deprovisioning, error The health state of a resource.
unknown, healthy, degraded, error The resource description, this optionally augments the name with more context.
The user who created the resource.
The time a resource was updated.
The user who updated the resource.
The time the resource was deleted.
An organization.
Show child attributes
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.
adhoc, domain The email domain of the organization.
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.
global, organization 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.
When set this identifies the customer ID for the google managed organization. This field is currently unused.