Org User Account Type Management

Organization management functions.

List account types for the organization

get

Retrieves the account types registered within the specified organization. These account types are available for linking to user accounts. This endpoint is intended for organizational management and provides essential information for user account type definitions.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

organizationIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/directory/orgs/{organizationId}/accounts/types

HTTPcURLJavaScriptPython

GET /directory/orgs/{organizationId}/accounts/types HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "text",
    "code": "text",
    "name": "text",
    "description": "text",
    "org_id": "text",
    "status": "draft",
    "creation_date": "2025-12-16T22:08:01.215Z",
    "modified_date": "2025-12-16T22:08:01.215Z",
    "requirements": {
      "ekyc_required": true,
      "totp_required": true,
      "email_required": true,
      "payment_required": true,
      "employer_required": true
    },
    "specifications": {
      "expiry_period": "text",
      "validity_period": "text"
    },
    "agreements": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "status": "text",
        "type": "text"
      }
    ],
    "subscriptions": [
      "text"
    ],
    "permissions": [
      "text"
    ],
    "roles": [
      {
        "id": "text",
        "name": "text",
        "namespace": "text",
        "description": "text",
        "stage": "alpha",
        "permissions": [
          {
            "scope": "text"
          }
        ]
      }
    ]
  }
]

Creates a new user account type for an organization

post

This endpoint allows the creation of a user account type within a specified organization. It is intended for management purposes to define various account types and their related information. Ensure that the provided payload meets the required specifications for successful creation.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

organizationIdstringRequired

Body

application/json

idstringOptional

codestringOptional

namestringOptional

descriptionstringOptional

org_idstringOptional

statusstring · enumOptionalPossible values:

creation_datestring · date-timeOptional

modified_datestring · date-timeOptional

subscriptionsstring[]Optional

permissionsstring[]Optional

Responses

200

OK

*/*

401

Unauthorized

*/*

post

/directory/orgs/{organizationId}/accounts/types

HTTPcURLJavaScriptPython

POST /directory/orgs/{organizationId}/accounts/types HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 647

{
  "id": "text",
  "code": "text",
  "name": "text",
  "description": "text",
  "org_id": "text",
  "status": "draft",
  "creation_date": "2025-12-16T22:08:01.215Z",
  "modified_date": "2025-12-16T22:08:01.215Z",
  "requirements": {
    "ekyc_required": true,
    "totp_required": true,
    "email_required": true,
    "payment_required": true,
    "employer_required": true
  },
  "specifications": {
    "expiry_period": "text",
    "validity_period": "text"
  },
  "agreements": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "status": "text",
      "type": "text"
    }
  ],
  "subscriptions": [
    "text"
  ],
  "permissions": [
    "text"
  ],
  "roles": [
    {
      "id": "text",
      "name": "text",
      "namespace": "text",
      "description": "text",
      "stage": "alpha",
      "permissions": [
        {
          "scope": "text"
        }
      ]
    }
  ]
}

{
  "id": "text",
  "code": "text",
  "name": "text",
  "description": "text",
  "org_id": "text",
  "status": "draft",
  "creation_date": "2025-12-16T22:08:01.215Z",
  "modified_date": "2025-12-16T22:08:01.215Z",
  "requirements": {
    "ekyc_required": true,
    "totp_required": true,
    "email_required": true,
    "payment_required": true,
    "employer_required": true
  },
  "specifications": {
    "expiry_period": "text",
    "validity_period": "text"
  },
  "agreements": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "status": "text",
      "type": "text"
    }
  ],
  "subscriptions": [
    "text"
  ],
  "permissions": [
    "text"
  ],
  "roles": [
    {
      "id": "text",
      "name": "text",
      "namespace": "text",
      "description": "text",
      "stage": "alpha",
      "permissions": [
        {
          "scope": "text"
        }
      ]
    }
  ]
}

Update account type for organization users

get

This endpoint allows the updating of a specific user account type within an organization. It ensures that the modifications are applied to the correct account type identified by the provided code. This operation is essential for maintaining accurate account type definitions and user management.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

organizationIdstringRequired

codestringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/directory/orgs/{organizationId}/accounts/types/{code}

HTTPcURLJavaScriptPython

GET /directory/orgs/{organizationId}/accounts/types/{code} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "text",
  "code": "text",
  "name": "text",
  "description": "text",
  "org_id": "text",
  "status": "draft",
  "creation_date": "2025-12-16T22:08:01.215Z",
  "modified_date": "2025-12-16T22:08:01.215Z",
  "requirements": {
    "ekyc_required": true,
    "totp_required": true,
    "email_required": true,
    "payment_required": true,
    "employer_required": true
  },
  "specifications": {
    "expiry_period": "text",
    "validity_period": "text"
  },
  "agreements": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "status": "text",
      "type": "text"
    }
  ],
  "subscriptions": [
    "text"
  ],
  "permissions": [
    "text"
  ],
  "roles": [
    {
      "id": "text",
      "name": "text",
      "namespace": "text",
      "description": "text",
      "stage": "alpha",
      "permissions": [
        {
          "scope": "text"
        }
      ]
    }
  ]
}

Update an organization's user account type

put

This endpoint allows for the modification of a specific user account type within an organization. It requires the organization ID and the account type code to identify the account type to be updated. Ensure that the provided payload contains the necessary details for the update.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

organizationIdstringRequired

codestringRequired

Body

application/json

idstringOptional

codestringOptional

namestringOptional

descriptionstringOptional

org_idstringOptional

statusstring · enumOptionalPossible values:

creation_datestring · date-timeOptional

modified_datestring · date-timeOptional

subscriptionsstring[]Optional

permissionsstring[]Optional

Responses

200

OK

*/*

401

Unauthorized

*/*

put

/directory/orgs/{organizationId}/accounts/types/{code}

HTTPcURLJavaScriptPython

PUT /directory/orgs/{organizationId}/accounts/types/{code} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 647

{
  "id": "text",
  "code": "text",
  "name": "text",
  "description": "text",
  "org_id": "text",
  "status": "draft",
  "creation_date": "2025-12-16T22:08:01.215Z",
  "modified_date": "2025-12-16T22:08:01.215Z",
  "requirements": {
    "ekyc_required": true,
    "totp_required": true,
    "email_required": true,
    "payment_required": true,
    "employer_required": true
  },
  "specifications": {
    "expiry_period": "text",
    "validity_period": "text"
  },
  "agreements": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "status": "text",
      "type": "text"
    }
  ],
  "subscriptions": [
    "text"
  ],
  "permissions": [
    "text"
  ],
  "roles": [
    {
      "id": "text",
      "name": "text",
      "namespace": "text",
      "description": "text",
      "stage": "alpha",
      "permissions": [
        {
          "scope": "text"
        }
      ]
    }
  ]
}

{
  "id": "text",
  "code": "text",
  "name": "text",
  "description": "text",
  "org_id": "text",
  "status": "draft",
  "creation_date": "2025-12-16T22:08:01.215Z",
  "modified_date": "2025-12-16T22:08:01.215Z",
  "requirements": {
    "ekyc_required": true,
    "totp_required": true,
    "email_required": true,
    "payment_required": true,
    "employer_required": true
  },
  "specifications": {
    "expiry_period": "text",
    "validity_period": "text"
  },
  "agreements": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "status": "text",
      "type": "text"
    }
  ],
  "subscriptions": [
    "text"
  ],
  "permissions": [
    "text"
  ],
  "roles": [
    {
      "id": "text",
      "name": "text",
      "namespace": "text",
      "description": "text",
      "stage": "alpha",
      "permissions": [
        {
          "scope": "text"
        }
      ]
    }
  ]
}

Admin delete account type for organization.

delete

This endpoint allows administrators to delete a specified account type for a given organization. It ensures that account types are managed effectively, maintaining the integrity of user account definitions. Proper authentication is required to perform this action.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

organizationIdstringRequired

codestringRequired

Body

application/json

stringOptional

Responses

200

OK

401

Unauthorized

*/*

delete

/directory/orgs/{organizationId}/accounts/types/{code}

HTTPcURLJavaScriptPython

DELETE /directory/orgs/{organizationId}/accounts/types/{code} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

No content