Org Account Management

Organization management functions.

Retrieve user accounts for the organization.

get

This endpoint returns the account types registered within the specified organization. These accounts can be linked to users, providing visibility into available user account options. It is designed to facilitate user account management and enhance the linking process.

👤 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/users

HTTPcURLJavaScriptPython

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

[
  {
    "identity": {
      "id": "text",
      "traits": {
        "name": {
          "given_name": "text",
          "family_name": "text",
          "middle_name": "text"
        },
        "birthdate": "2025-12-16",
        "email": "text",
        "username": "text",
        "gender": "male",
        "citizenship": "text",
        "locale": "text"
      },
      "metadata_public": {
        "picture": "text"
      }
    },
    "org_id": "text",
    "acls": [
      "text"
    ],
    "status": "active",
    "creation_date": "2025-12-16T22:08:02.699Z",
    "effective_date": "2025-12-16T22:08:02.699Z"
  }
]

Assign a user to an account type.

post

This endpoint creates an association between a user and a specific account type within the organization. It allows for the management of user account types, ensuring proper categorization and access control. This operation is essential for maintaining user account integrity and organization compliance.

👤 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

subjectIdstringRequired

codestringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

post

/directory/orgs/{organizationId}/accounts/users/{subjectId}/{code}

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "account_code": "text",
  "org_id": "text",
  "subject_id": "text",
  "status": "active",
  "creation_date": "2025-12-16T22:08:02.699Z",
  "effective_date": "2025-12-16T22:08:02.699Z",
  "expiration_date": "2025-12-16T22:08:02.699Z"
}

Update user account type for organization

put

This endpoint allows the updating of a user account type within a specified organization. It requires the organization ID, subject ID, and the new account type code. Ensure that the user has the necessary permissions 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

subjectIdstringRequired

codestringRequired

Body

application/json

statusstring · enumOptionalPossible values:

Responses

200

OK

*/*

401

Unauthorized

*/*

put

/directory/orgs/{organizationId}/accounts/users/{subjectId}/{code}

HTTPcURLJavaScriptPython

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

{
  "status": "active"
}

{
  "id": "text",
  "account_code": "text",
  "org_id": "text",
  "subject_id": "text",
  "status": "active",
  "creation_date": "2025-12-16T22:08:02.699Z",
  "effective_date": "2025-12-16T22:08:02.699Z",
  "expiration_date": "2025-12-16T22:08:02.699Z"
}

Delete a user account for the organization

delete

This endpoint allows for the deletion of a user account associated with the specified organization. It is intended for use by authorized personnel to manage user accounts effectively. Ensure that the correct organization ID and user details are provided to avoid unintended deletions.

👤 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

subjectIdstringRequired

Body

application/json

stringOptional

Responses

200

OK

401

Unauthorized

*/*

delete

/directory/orgs/{organizationId}/accounts/users/{subjectId}/{code}

HTTPcURLJavaScriptPython

DELETE /directory/orgs/{organizationId}/accounts/users/{subjectId}/{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