API Reference

Krystal Identity API

Resources & Endpoints

Bulk update organization policy fields for an OAuth client

Allows an OAuth client to update multiple organization policy fields at once.

PUT
https://identity.krystal.io/api/v1/client/organization_policy_fields/synchronize

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

organization_policy_fields Required

OrganizationPolicyFieldProperties Array None

Potential Errors

The following errors may occur during this request.

Details HTTP status

payload_too_large

The request is larger than the server is willing or able to process

 413 Payload Too Large

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_policy_fields: [ OrganizationPolicyField {
        default_value: String?
        group: String
        key: String
        label: String
        placeholder: String?
        sub_text: String?
        suffix: String?
        value_type: OrganizationPolicyFieldValueTypeEnum
        oauth_client: OAuthClient {
            id: String
            auth_method: String
            client_credentials: Boolean
            description: String?
            first_party: Boolean
            name: String
            redirect_uris: [ String ]
            verified: Boolean
            webhook_url: String?
        }
    } ]
}