Create organization

Creates a new organization.

POST
https://identity.krystal.io/api/v1/client/organizations

If successful, this endpoint will return a 200 OK status.

Scopes

One of the following scopes are required to use this endpoint.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

properties Required

OrganizationCreateProperties None

Potential Errors

The following errors may occur during this request.

Details HTTP status

invalid_user

A user ID was provided that does not match any user

422 Unprocessable Entity

validation_error

An error ocurred with the input provided

422 Unprocessable Entity

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    organization: Organization {
        id: String
        name: String
        identifier: String
        time_zone: String?
        updated_at: Unix Timestamp
        two_factor_required: Boolean
        managed: Boolean
        parent_id: String?
        users: [ OrganizationUser {
            user_id: String
            organization_id: String
            organization_name: String
            organization_identifier: String
            organization_managed: Boolean
            organization_parent_id: String?
            owner: Boolean
            organization_updated_at: Unix Timestamp
            roles: [ String? ]
        } ]
        policy: OrganizationPolicy? {
            name: String
            type: OrganizationPolicyTypeEnum
            limits: [ OrganizationPolicyLimit {
                key: String
                value: String?
                value_type: OrganizationPolicyFieldValueTypeEnum
                label: String
                suffix: String?
                sub_text: String?
            } ]
        }
    }
}