Project Role APIs

Creating and managing the roles your users have in your app.

Retrieve groups for a specific user in the app

get

This endpoint fetches the groups associated with a specific user for a given application within a project. It ensures that the data returned is relevant to the user's context, facilitating effective role management. Use this to understand user group memberships 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

appIdstringRequired

subjectIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/projects/{projectId}/app/{appId}/users/{subjectId}/groups

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/app/{appId}/users/{subjectId}/groups HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "subject": {},
    "scope": {},
    "object": {}
  }
]

Add a group to a user's project role

post

This endpoint allows adding a specified group to a user within the context of a project. It ensures that users can be organized into groups for better role management. This operation is essential for maintaining user permissions and access levels in the application.

👤 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

appIdstringRequired

subjectIdstringRequired

groupIdstringRequired

Responses

200

OK

No content

401

Unauthorized

*/*

post

/console/projects/{projectId}/app/{appId}/users/{subjectId}/groups/{groupId}

HTTPcURLJavaScriptPython

POST /console/projects/{projectId}/app/{appId}/users/{subjectId}/groups/{groupId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Remove a specific group from a user.

delete

This endpoint allows for the removal of a group associated with a specific user within a project and application context. It ensures that the user's group membership is updated accordingly. This operation is crucial for managing user roles and permissions 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

appIdstringRequired

subjectIdstringRequired

groupIdstringRequired

Responses

200

OK

No content

401

Unauthorized

*/*

delete

/console/projects/{projectId}/app/{appId}/users/{subjectId}/groups/{groupId}

HTTPcURLJavaScriptPython

DELETE /console/projects/{projectId}/app/{appId}/users/{subjectId}/groups/{groupId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Retrieve roles assigned to a user for an app

get

Fetches the roles associated with a specific user within a given application. This endpoint is designed to provide visibility into user permissions and roles, ensuring that users can manage their access effectively. Ideal for applications requiring role-based access control.

👤 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

appIdstringRequired

subjectIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/projects/{projectId}/app/{appId}/users/{subjectId}/roles

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/app/{appId}/users/{subjectId}/roles HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "subject": {},
    "scope": {},
    "object": {}
  }
]

Assign a role to a user in a project

post

This endpoint allows you to assign a specific role to a user within a given project. It is intended for managing user permissions effectively. Ensure that the user and role exist before making this request. This operation is crucial for maintaining appropriate access levels in your application.

👤 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

appIdstringRequired

subjectIdstringRequired

roleIdstringRequired

Responses

200

OK

No content

401

Unauthorized

*/*

post

/console/projects/{projectId}/app/{appId}/users/{subjectId}/roles/{roleId}

HTTPcURLJavaScriptPython

POST /console/projects/{projectId}/app/{appId}/users/{subjectId}/roles/{roleId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Remove a specific role from a user.

delete

This endpoint allows the removal of a designated role for a specific user within a project application. It ensures that the role is deleted securely, reflecting the user's current permissions. This operation is crucial for managing user access and maintaining security within the application.

👤 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

appIdstringRequired

subjectIdstringRequired

roleIdstringRequired

Responses

200

OK

No content

401

Unauthorized

*/*

delete

/console/projects/{projectId}/app/{appId}/users/{subjectId}/roles/{roleId}

HTTPcURLJavaScriptPython

DELETE /console/projects/{projectId}/app/{appId}/users/{subjectId}/roles/{roleId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content