Credentials APIs

For management of project credentials and app credentials.

List clients for a specific project

get

Retrieves all OIDC clients associated with the provided project ID. If the project is not ready due to dependencies, an error will be returned. This endpoint ensures that users can manage client configurations effectively.

👤 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

projectIdstringRequired

Responses

200

The oidc clients registered for this project

application/json

401

Unauthorized

*/*

get

/console/projects/{projectId}/clients

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/clients HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "name": "text",
    "client_id": "text",
    "secret_key": "text",
    "access_token_strategy": "jwt",
    "token_endpoint_auth_method": "client_secret_basic",
    "subject_type": "pairwise",
    "scopes": [
      "text"
    ],
    "audience": [
      "text"
    ],
    "creation_date": "2026-02-13T01:36:06.435Z",
    "status": "enabled",
    "authorized_origins": [
      "text"
    ],
    "authorized_redirect_uris": [
      "text"
    ],
    "access_token_lifespan": "text",
    "id_token_lifespan": "text",
    "refresh_token_lifespan": "text",
    "skip_consent": true
  }
]

Create a new OAuth 2.0 client for projects

post

This endpoint allows the creation of a new OAuth 2.0 client. It supports consent management and user interaction, enabling secure access for project-related functionalities. Use this to register clients that will interact with user data and permissions.

👤 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

projectIdstringRequired

Body

application/json

access_token_strategystring · enumOptionalPossible values:

token_endpoint_auth_methodstring · enumOptionalPossible values:

subject_typestring · enumOptionalPossible values:

namestringOptional

client_idstringOptional

audiencestring[]Optional

statusstring · enumOptionalPossible values:

access_token_lifespanstringOptional

refresh_token_lifespanstringOptional

authorized_redirect_urlsstring[]Optional

scopesstring[]Optional

authorized_originsstring[]Optional

userinfo_signed_response_algstring · enumOptionalPossible values:

Responses

200

The permissions granted to the specified client.

application/json

401

Unauthorized

*/*

post

/console/projects/{projectId}/clients

HTTPcURLJavaScriptPython

POST /console/projects/{projectId}/clients HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 366

{
  "access_token_strategy": "jwt",
  "token_endpoint_auth_method": "client_secret_basic",
  "subject_type": "pairwise",
  "name": "text",
  "client_id": "text",
  "audience": [
    "text"
  ],
  "status": "enabled",
  "access_token_lifespan": "text",
  "refresh_token_lifespan": "text",
  "authorized_redirect_urls": [
    "text"
  ],
  "scopes": [
    "text"
  ],
  "authorized_origins": [
    "text"
  ],
  "userinfo_signed_response_alg": "RS256"
}

{
  "name": "text",
  "client_id": "text",
  "secret_key": "text",
  "access_token_strategy": "jwt",
  "token_endpoint_auth_method": "client_secret_basic",
  "subject_type": "pairwise",
  "scopes": [
    "text"
  ],
  "audience": [
    "text"
  ],
  "creation_date": "2026-02-13T01:36:06.435Z",
  "status": "enabled",
  "authorized_origins": [
    "text"
  ],
  "authorized_redirect_uris": [
    "text"
  ],
  "access_token_lifespan": "text",
  "id_token_lifespan": "text",
  "refresh_token_lifespan": "text",
  "skip_consent": true
}

Update an existing OAuth 2.0 client configuration.

put

This endpoint allows you to update the specified OAuth 2.0 client. You can modify redirect URLs and other parameters associated with the client. It is essential for maintaining the correct configuration of clients used in project 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

projectIdstringRequired

clientIdstringRequired

Body

application/json

access_token_strategystring · enumOptionalPossible values:

token_endpoint_auth_methodstring · enumOptionalPossible values:

subject_typestring · enumOptionalPossible values:

namestringOptional

client_idstringOptional

audiencestring[]Optional

statusstring · enumOptionalPossible values:

access_token_lifespanstringOptional

refresh_token_lifespanstringOptional

authorized_redirect_urlsstring[]Optional

scopesstring[]Optional

authorized_originsstring[]Optional

userinfo_signed_response_algstring · enumOptionalPossible values:

Responses

200

The updated result.

application/json

401

Unauthorized

*/*

put

/console/projects/{projectId}/clients/{clientId}

HTTPcURLJavaScriptPython

PUT /console/projects/{projectId}/clients/{clientId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 366

{
  "access_token_strategy": "jwt",
  "token_endpoint_auth_method": "client_secret_basic",
  "subject_type": "pairwise",
  "name": "text",
  "client_id": "text",
  "audience": [
    "text"
  ],
  "status": "enabled",
  "access_token_lifespan": "text",
  "refresh_token_lifespan": "text",
  "authorized_redirect_urls": [
    "text"
  ],
  "scopes": [
    "text"
  ],
  "authorized_origins": [
    "text"
  ],
  "userinfo_signed_response_alg": "RS256"
}

{
  "name": "text",
  "client_id": "text",
  "secret_key": "text",
  "access_token_strategy": "jwt",
  "token_endpoint_auth_method": "client_secret_basic",
  "subject_type": "pairwise",
  "scopes": [
    "text"
  ],
  "audience": [
    "text"
  ],
  "creation_date": "2026-02-13T01:36:06.435Z",
  "status": "enabled",
  "authorized_origins": [
    "text"
  ],
  "authorized_redirect_uris": [
    "text"
  ],
  "access_token_lifespan": "text",
  "id_token_lifespan": "text",
  "refresh_token_lifespan": "text",
  "skip_consent": true
}

Delete a specific OAuth 2.0 client.

delete

This endpoint allows you to delete a specified OAuth 2.0 client. It will also disable the client and any associated logins. Ensure that you have 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

projectIdstringRequired

clientIdstringRequired

Responses

200

The delete was applied.

*/*

401

Unauthorized

*/*

delete

/console/projects/{projectId}/clients/{clientId}

HTTPcURLJavaScriptPython

DELETE /console/projects/{projectId}/clients/{clientId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "name": "text",
  "client_id": "text",
  "secret_key": "text",
  "access_token_strategy": "jwt",
  "token_endpoint_auth_method": "client_secret_basic",
  "subject_type": "pairwise",
  "scopes": [
    "text"
  ],
  "audience": [
    "text"
  ],
  "creation_date": "2026-02-13T01:36:06.435Z",
  "status": "enabled",
  "authorized_origins": [
    "text"
  ],
  "authorized_redirect_uris": [
    "text"
  ],
  "access_token_lifespan": "text",
  "id_token_lifespan": "text",
  "refresh_token_lifespan": "text",
  "skip_consent": true
}

Retrieve permissions for a specific client.

get

This endpoint returns the permissions assigned to the specified client within a project. It provides visibility into what actions the client is authorized to perform, ensuring proper access control and management. Use this information to understand client capabilities and enhance project security.

👤 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

projectIdstringRequired

clientIdstringRequired

Responses

200

The permissions granted to the specified client.

application/json

Responsestring[]

401

Unauthorized

*/*

get

/console/projects/{projectId}/clients/{clientId}/permissions

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/clients/{clientId}/permissions HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  "text"
]

Update permissions for a specific project client.

post

This endpoint allows you to create or update the permissions for a specified client associated with a project. It ensures that the permissions are tailored to the client's needs, enhancing project management and collaboration. Use this to maintain control over client access and capabilities.

👤 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

projectIdstringRequired

clientIdstringRequired

Body

application/json

permissionsstring[]Optional

Responses

200

The permissions granted to the specified client.

application/json

Responsestring[]

401

Unauthorized

*/*

post

/console/projects/{projectId}/clients/{clientId}/permissions

HTTPcURLJavaScriptPython

POST /console/projects/{projectId}/clients/{clientId}/permissions HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "permissions": [
    "text"
  ]
}

[
  "text"
]

Retrieve the secret key for a specific client.

get

This endpoint allows you to obtain the secret key associated with a specified client within a project. It is essential for managing client authentication and ensuring secure interactions. Use this operation to access sensitive credentials while maintaining appropriate security measures.

👤 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

projectIdstringRequired

clientIdstringRequired

Responses

200

The permissions granted to the specified client.

application/json

401

Unauthorized

*/*

get

/console/projects/{projectId}/clients/{clientId}/secret

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/clients/{clientId}/secret HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "name": "text",
  "client_id": "text",
  "secret_key": "text",
  "access_token_strategy": "jwt",
  "token_endpoint_auth_method": "client_secret_basic",
  "subject_type": "pairwise",
  "scopes": [
    "text"
  ],
  "audience": [
    "text"
  ],
  "creation_date": "2026-02-13T01:36:06.435Z",
  "status": "enabled",
  "authorized_origins": [
    "text"
  ],
  "authorized_redirect_uris": [
    "text"
  ],
  "access_token_lifespan": "text",
  "id_token_lifespan": "text",
  "refresh_token_lifespan": "text",
  "skip_consent": true
}

List all credentials for the specified project

get

Retrieves all OIDC credentials associated with the given project ID. This endpoint is intended for users with appropriate permissions to manage project credentials. Ensure you have the necessary authentication to access this information.

👤 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

projectIdstringRequired

Responses

200

The oidc credentials registered for this project

application/json

401

Unauthorized

*/*

get

/console/projects/{projectId}/credentials

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/credentials HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "name": "text",
    "client_id": "text",
    "secret_key": "text",
    "access_token_strategy": "jwt",
    "token_endpoint_auth_method": "client_secret_basic",
    "creation_date": "2026-02-13T01:36:06.435Z",
    "audience": [
      "text"
    ],
    "status": "enabled"
  }
]

Create a new service credential for a project

post

This endpoint allows the creation of a service credential for authenticating service-to-service interactions within a specified project. The credential facilitates secure communication between services. Ensure proper permissions are granted to the client for successful registration.

👤 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

projectIdstringRequired

Body

application/json

access_token_strategystring · enumOptionalPossible values:

token_endpoint_auth_methodstring · enumOptionalPossible values:

namestringOptional

audiencestring[]Optional

client_idstringOptional

client_secretstringOptional

statusstring · enumOptionalPossible values:

scopesstring[]Optional

Responses

200

The permissions granted to the specified client.

application/json

401

Unauthorized

*/*

post

/console/projects/{projectId}/credentials

HTTPcURLJavaScriptPython

POST /console/projects/{projectId}/credentials HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 195

{
  "access_token_strategy": "jwt",
  "token_endpoint_auth_method": "client_secret_basic",
  "name": "text",
  "audience": [
    "text"
  ],
  "client_id": "text",
  "client_secret": "text",
  "status": "enabled",
  "scopes": [
    "text"
  ]
}

{
  "name": "text",
  "client_id": "text",
  "secret_key": "text",
  "access_token_strategy": "jwt",
  "token_endpoint_auth_method": "client_secret_basic",
  "creation_date": "2026-02-13T01:36:06.435Z",
  "audience": [
    "text"
  ],
  "status": "enabled"
}

Update project service credentials.

put

This endpoint allows for the updating of service credentials associated with a specific project. It enables modifications to the properties of the credentials, ensuring that they remain current and secure. Use this operation to manage credentials effectively within your project's scope.

👤 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

projectIdstringRequired

clientIdstringRequired

Body

application/json

access_token_strategystring · enumOptionalPossible values:

token_endpoint_auth_methodstring · enumOptionalPossible values:

namestringOptional

audiencestring[]Optional

client_idstringOptional

client_secretstringOptional

statusstring · enumOptionalPossible values:

scopesstring[]Optional

Responses

200

The updated result.

application/json

401

Unauthorized

*/*

put

/console/projects/{projectId}/credentials/{clientId}

HTTPcURLJavaScriptPython

PUT /console/projects/{projectId}/credentials/{clientId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 195

{
  "access_token_strategy": "jwt",
  "token_endpoint_auth_method": "client_secret_basic",
  "name": "text",
  "audience": [
    "text"
  ],
  "client_id": "text",
  "client_secret": "text",
  "status": "enabled",
  "scopes": [
    "text"
  ]
}

{
  "name": "text",
  "client_id": "text",
  "secret_key": "text",
  "access_token_strategy": "jwt",
  "token_endpoint_auth_method": "client_secret_basic",
  "creation_date": "2026-02-13T01:36:06.435Z",
  "audience": [
    "text"
  ],
  "status": "enabled"
}

Delete a specific project service credential

delete

This endpoint allows users to delete a specified service credential associated with a project. Ensure that the correct projectId and clientId are provided for successful deletion. This operation is crucial for maintaining security and managing access to project resources.

👤 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

projectIdstringRequired

clientIdstringRequired

Responses

200

OK

No content

401

Unauthorized

*/*

delete

/console/projects/{projectId}/credentials/{clientId}

HTTPcURLJavaScriptPython

DELETE /console/projects/{projectId}/credentials/{clientId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Retrieve permissions for a specific project credential

get

This endpoint returns the permissions assigned to the specified service credential for a project. It provides visibility into what actions can be performed with the credential. Use this information to manage access and ensure proper authorization for project-related tasks.

👤 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

projectIdstringRequired

clientIdstringRequired

Responses

200

The permissions granted to the specified credential.

application/json

Responsestring[]

401

Unauthorized

*/*

get

/console/projects/{projectId}/credentials/{clientId}/permissions

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/credentials/{clientId}/permissions HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  "text"
]

Update permissions for project service credentials.

post

This endpoint allows you to create or modify the permissions associated with specific service credentials for a project. It ensures that the correct access levels are granted based on the provided parameters. Use this to manage credential permissions effectively within your project.

👤 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

projectIdstringRequired

clientIdstringRequired

Body

application/json

permissionsstring[]Optional

Responses

200

The permissions granted to the specified credentials.

application/json

Responsestring[]

401

Unauthorized

*/*

post

/console/projects/{projectId}/credentials/{clientId}/permissions

HTTPcURLJavaScriptPython

POST /console/projects/{projectId}/credentials/{clientId}/permissions HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "permissions": [
    "text"
  ]
}

[
  "text"
]

Update roles for project service credentials.

post

This endpoint allows you to create or update roles assigned to a specific service credential within a project. It ensures that the specified roles are accurately reflected for the given credential, enhancing access control and permissions 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

projectIdstringRequired

clientIdstringRequired

Body

application/json

rolesstring[]Optional

Responses

200

The roles granted to the specified credentials.

application/json

Responsestring[]

401

Unauthorized

*/*

post

/console/projects/{projectId}/credentials/{clientId}/roles

HTTPcURLJavaScriptPython

POST /console/projects/{projectId}/credentials/{clientId}/roles HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "roles": [
    "text"
  ]
}

[
  "text"
]

Retrieve project service credentials secret key.

get

This endpoint allows you to access the secret key for the specified service credentials associated with a project. It is intended for authorized users to manage project credentials securely. Ensure that you have the necessary permissions to access this sensitive information.

👤 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

projectIdstringRequired

clientIdstringRequired

Responses

200

The permissions granted to the specified client.

application/json

401

Unauthorized

*/*

get

/console/projects/{projectId}/credentials/{clientId}/secret

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/credentials/{clientId}/secret HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "name": "text",
  "client_id": "text",
  "secret_key": "text",
  "access_token_strategy": "jwt",
  "token_endpoint_auth_method": "client_secret_basic",
  "creation_date": "2026-02-13T01:36:06.435Z",
  "audience": [
    "text"
  ],
  "status": "enabled"
}