Organizations

Create Organization

$ nirvana organizations create

POST/v1/organizations

Get Organization Details

$ nirvana organizations get

GET/v1/organizations/{organization_id}

Update Organization

$ nirvana organizations update

PATCH/v1/organizations/{organization_id}

List Organizations

$ nirvana organizations list

GET/v1/organizations

Leave Organization

$ nirvana organizations leave

POST/v1/organizations/{organization_id}/leave

ModelsExpand Collapse

organization: object { id, billing_email, created_at, 9 more }

Organization response.

id: string

Organization ID.

billing_email: string

Billing email. Null when no custom billing email is set (reverts to the oldest owner’s email).

created_at: string

When the Organization was created.

domains: array of OrganizationDomain { id, domain, verified }

Domains associated with the organization.

id: string

Domain ID.

domain: string

Domain name.

verified: boolean

Whether the domain has been verified.

metronome_customer_id: string

Metronome customer ID.

name: string

Organization name.

personal: boolean

Whether the organization is a personal Organization.

services: object { cloud, jit_provisioning, scim, 2 more }

Services that the Organization has access to.

cloud: boolean

Whether cloud services are enabled for the organization.

jit_provisioning: boolean

Whether just-in-time provisioning is enabled for the organization.

scim: boolean

Whether SCIM provisioning is enabled for the organization.

siem: boolean

Whether SIEM integration is enabled for the organization.

sso: boolean

Whether single sign-on is enabled for the organization.

stripe_customer_id: string

Stripe customer ID.

type: "personal" or "company"

Organization type.

"personal"

"company"

updated_at: string

When the Organization was updated.

auth_id: optional string

Authentication provider organization ID.

organization_domain: object { id, domain, verified }

Organization domain details.

id: string

Domain ID.

domain: string

Domain name.

verified: boolean

Whether the domain has been verified.

organization_list: object { items, pagination }

items: array of Organization { id, billing_email, created_at, 9 more }

id: string

Organization ID.

billing_email: string

Billing email. Null when no custom billing email is set (reverts to the oldest owner’s email).

created_at: string

When the Organization was created.

domains: array of OrganizationDomain { id, domain, verified }

Domains associated with the organization.

id: string

Domain ID.

domain: string

Domain name.

verified: boolean

Whether the domain has been verified.

metronome_customer_id: string

Metronome customer ID.

name: string

Organization name.

personal: boolean

Whether the organization is a personal Organization.

services: object { cloud, jit_provisioning, scim, 2 more }

Services that the Organization has access to.

cloud: boolean

Whether cloud services are enabled for the organization.

jit_provisioning: boolean

Whether just-in-time provisioning is enabled for the organization.

scim: boolean

Whether SCIM provisioning is enabled for the organization.

siem: boolean

Whether SIEM integration is enabled for the organization.

sso: boolean

Whether single sign-on is enabled for the organization.

stripe_customer_id: string

Stripe customer ID.

type: "personal" or "company"

Organization type.

"personal"

"company"

updated_at: string

When the Organization was updated.

auth_id: optional string

Authentication provider organization ID.

pagination: object { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

organization_services: object { cloud, jit_provisioning, scim, 2 more }

Services that the Organization has access to.

cloud: boolean

Whether cloud services are enabled for the organization.

jit_provisioning: boolean

Whether just-in-time provisioning is enabled for the organization.

scim: boolean

Whether SCIM provisioning is enabled for the organization.

siem: boolean

Whether SIEM integration is enabled for the organization.

sso: boolean

Whether single sign-on is enabled for the organization.

organization_type: "personal" or "company"

Organization type.

"personal"

"company"

OrganizationsMemberships

Get Organization Membership

$ nirvana organizations:memberships get

GET/v1/organizations/{organization_id}/memberships/{membership_id}

List Organization Memberships

$ nirvana organizations:memberships list

GET/v1/organizations/{organization_id}/memberships

ModelsExpand Collapse

organization_membership: object { id, created_at, organization_id, 3 more }

Organization membership details.

id: string

Membership ID.

created_at: string

When the membership was created.

organization_id: string

Organization ID.

role: "owner" or "member"

Role of the user in the organization.

"owner"

"member"

updated_at: string

When the membership was updated.

user_id: string

User ID.

organization_membership_list: object { items, pagination }

items: array of OrganizationMembership { id, created_at, organization_id, 3 more }

id: string

Membership ID.

created_at: string

When the membership was created.

organization_id: string

Organization ID.

role: "owner" or "member"

Role of the user in the organization.

"owner"

"member"

updated_at: string

When the membership was updated.

user_id: string

User ID.

pagination: object { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

OrganizationsAddress

Create Organization Address

$ nirvana organizations:address create

POST/v1/organizations/{organization_id}/address

Get Organization Address

$ nirvana organizations:address get

GET/v1/organizations/{organization_id}/address

Update Organization Address

$ nirvana organizations:address update

PATCH/v1/organizations/{organization_id}/address

ModelsExpand Collapse

organization_address: object { id, city, country, 9 more }

Organization address details.

id: string

Address ID.

city: string

City or locality.

country: string

Two-letter ISO 3166-1 alpha-2 country code.

created_at: string

When the address was created.

line1: string

First line of the street address.

line2: string

Second line of the street address. Null when not provided.

organization_id: string

Organization ID the address belongs to.

postal_code: string

Postal or ZIP code.

state: string

State, province, or region. Null when not provided.

tax_id: string

Tax identification number. Null when not provided.

tax_id_type: string

Type of the tax identification number. Null when not provided.

updated_at: string

When the address was updated.