API Reference

Krystal Identity API

Resources & Endpoints

Create invite

Invites a user to the organization.

POST
https://identity.krystal.io/api/v1/organizations/{organization}/invites

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

InviteProperties None

organization Required

Organization Lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

organization_not_found

No organization was found matching any of the criteria provided in the arguments

 404 Not Found

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.

{
    invite: Invite {
        id: String
        inviter: User {
            id: String
            name: String
            first_name: String
            last_name: String
            time_zone: String
            two_factor_auth_enabled: Boolean
            email_address: String?
            email_addresses: [ String? ]
            roles: [ String ]
            identity_check_state: IdentityCheckStateEnum
            identity_check_verified_at: Unix Timestamp?
        }
        email_address: String
        expires_at: Unix Timestamp
        accepted_at: Unix Timestamp?
        rejected_at: Unix Timestamp?
        state: InviteStateEnum
    }
}