Get the information of a user

You can retrieve all the basic information of a user, including the status of the account in the system.

Permissions

info

This action requires the following IAM (Identity and Access Management) permissions:

• iam.user.get

Console

1 / 4From the left-hand side menu, click IAM → Users.

1 / 4

1. In the Users table, click the identifier associated with the user for which you want to get information.

tip

You can search for a specific user using the Search field.

2. The page containing the details of the user is displayed.

3. You can also view the list of spaces assigned to this user, as well as the roles and permissions granted to them for a given space.

4. By clicking X roles, you can view the list of roles granted to this user on one of the spaces to which they are associated.

5. By clicking X permissions, you can display the list of permissions granted to this user on one of the spaces to which they are associated.

API

Get the details of a user in an organization

https://docs.numspot.com/openapi/#tag/identity-access-management/GET/iam/organisations/{organisationId}/users/{userId}

Example:

curl 'https://api.{region}.numspot.com/iam/organisations/{organisationId}/users/{userId}'

Response:

{
  "email": "john.smith@acme.org",
  "firstname": "…",
  "lastname": "…",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "active": true,
  "createdOn": "2018-11-13T20:20:39+00:00",
  "updatedOn": "2018-11-13T20:20:39+00:00"
}

info

See the page on using the API for the implementation.

Get the details of a user in a space

https://docs.numspot.com/openapi/#tag/identity-access-management/GET/iam/spaces/{spaceId}/users/{userId}

Example:

curl 'https://api.{region}.numspot.com/iam/spaces/{spaceId}/users/{userId}'

Response:

{
  "email": "john.smith@acme.org",
  "firstname": "…",
  "lastname": "…",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "active": true,
  "createdOn": "2018-11-13T20:20:39+00:00",
  "updatedOn": "2018-11-13T20:20:39+00:00"
}

info

See the page on using the API for the implementation.

Get the list of spaces assigned to a user

https://docs.numspot.com/openapi/#tag/identity-access-management/GET/iam/organisations/{organisationId}/users/{userId}/spaces

Example:

curl 'https://api.{region}.numspot.com/iam/organisations/{organisationId}/users/{userId}/spaces'

Response:

{
  "nextPageToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
  "totalSize": 150,
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

info

See the page on using the API for the implementation.

Get the roles and permissions of a user account in an organization

https://docs.numspot.com/openapi/#tag/identity-access-management/GET/iam/organisations/{organisationId}/iampolicy/{subjectType}/{subjectId}

Example:

curl 'https://api.{region}.numspot.com/iam/organisations/{organisationId}/iampolicy/{subjectType}/{subjectId}'

Response:

{
  "roles": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "permissions": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

info

See the page on using the API for the implementation.

Get the roles and permissions of a user account in a space

https://docs.numspot.com/openapi/#tag/identity-access-management/GET/iam/spaces/{spaceId}/iampolicy/{subjectType}/{subjectId}

Example:

curl 'https://api.{region}.numspot.com/iam/spaces/{spaceId}/iampolicy/{subjectType}/{subjectId}'

Response:

{
  "roles": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "permissions": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

info

See the page on using the API for the implementation.

Terraform

The Terraform documentation is available on the Numspot registry ↗.