• Role Store

users

PrivX local and remote users and role mappings

get/role-store/api/v1/users/{user_id}

Get a user

Get a user and its roles.

user_idstring

required

User ID

Responses

Response examples

Successful response, returns user info

{
  "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "source_user_id": null,
  "created": "2017-01-01T15:05:05Z",
  "updated": "2017-01-01T15:05:05Z",
  "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "author": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "comment": "A comment",
  "tags": [
    "string"
  ],
  "principal": "string",
  "distinguished_name": "string",
  "given_name": "string",
  "full_name": "string",
  "job_title": "string",
  "company": "string",
  "department": "string",
  "email": "string",
  "telephone": "string",
  "locale": "fi_FI",
  "roles": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "name": "string",
      "comment": "A comment",
      "principal_public_key_strings": [
        "string"
      ],
      "permit_agent": true,
      "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "permissions": [
        "licenses-manage"
      ],
      "context": {
        "enabled": true,
        "block_role": true,
        "validity": [
          "MON"
        ],
        "start_time": "string",
        "end_time": "string",
        "timezone": "string",
        "ip_masks": [
          "string"
        ]
      },
      "explicit": true,
      "implicit": true,
      "system": true,
      "grant_type": "PERMANENT",
      "grant_validity_periods": [
        {
          "grant_start": "2017-01-01T15:05:05Z",
          "grant_end": "2017-01-02T15:05:05Z"
        }
      ],
      "floating_length": 24
    }
  ],
  "attributes": [
    {
      "key": "aws_account",
      "value": "admin-bob"
    }
  ],
  "permissions": [
    "licenses-manage"
  ],
  "source": "string",
  "mfa": {
    "status": "ENABLED",
    "seed": {
      "seed_string": "string",
      "seed_qr_code": "string"
    }
  },
  "stale_access_token": true,
  "authorized_keys": [
    {
      "id": "2765b005-4ce1-4b2b-a9ca-ee6c4d6f2792",
      "username": "joe@privx.com",
      "user_id": "f2f448d8-0397-4894-982f-9a58a43921db",
      "source": "5bf77342-221c-11ee-be56-0242ac120002",
      "name": "work",
      "comment": "Joe's work laptop key",
      "public_key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDqoMogqErOw7lL3GD6Ez7Hv1FZBk0Iyk2pBFUhqb9sjY9IEw8P9OWFwLMhWQ4LNvekPAnmr03pMHSSP7Pw98+Izy0HxcHZGKcrDOIjnHF5Fog3w4rBYa6OxdcJRxctifx5szqmM4JkUNS1RJY5E4ns4xCgFV46Satph02M+eP9PXGh+ZecSNtdLoOovVuolEUdb8dINgto8zsjEuAQ+76qOEgAIuSsYlzGGZPyPnATtkUi/rK9fcAfbhSqSXNxFqf7wejEKwA1kFt8hSW2bUWJH268fqnejFwHjBTzjBw89dji6141ajAP8/Q2gZug0bb1U70PE4afE3fFh2VCfhwT",
      "not_before": "2020-07-31T17:32:28Z",
      "not_after": "2022-07-31T17:32:28Z",
      "expires_in": 123,
      "source_address": [
        "192.168.100.0/24"
      ],
      "fingerprints": [
        "SHA256:bdeYZ2qiEwCOCuf0oTvya/aH4Vo+nJLIauDKm/D8btM"
      ]
    }
  ],
  "webauthn_credentials": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "credential_id": "string",
      "name": "string",
      "comment": "string",
      "last_used": "2017-01-01T15:05:05Z",
      "created": "2017-01-01T15:05:05Z",
      "author": "5bf77342-221c-11ee-be56-0242ac120002",
      "updated": "2017-01-01T15:05:05Z",
      "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
    }
  ]
}
get/role-store/api/v1/users/{user_id}/settings

Get a user's settings

Get specific user settings.

user_idstring

required

User id

Responses

Response examples

Successful response, returns user's settings

{}
put/role-store/api/v1/users/{user_id}/settings

Update a user's settings

Set specific user's settings.

Responses

Request examples

{}

Response examples

Successful response.

{
  "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "source_user_id": null,
  "created": "2017-01-01T15:05:05Z",
  "updated": "2017-01-01T15:05:05Z",
  "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "author": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "comment": "A comment",
  "tags": [
    "string"
  ],
  "principal": "string",
  "distinguished_name": "string",
  "given_name": "string",
  "full_name": "string",
  "job_title": "string",
  "company": "string",
  "department": "string",
  "email": "string",
  "telephone": "string",
  "locale": "fi_FI",
  "roles": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "name": "string",
      "comment": "A comment",
      "principal_public_key_strings": [
        "string"
      ],
      "permit_agent": true,
      "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "permissions": [
        "licenses-manage"
      ],
      "context": {
        "enabled": true,
        "block_role": true,
        "validity": [
          "MON"
        ],
        "start_time": "string",
        "end_time": "string",
        "timezone": "string",
        "ip_masks": [
          "string"
        ]
      },
      "explicit": true,
      "implicit": true,
      "system": true,
      "grant_type": "PERMANENT",
      "grant_validity_periods": [
        {
          "grant_start": "2017-01-01T15:05:05Z",
          "grant_end": "2017-01-02T15:05:05Z"
        }
      ],
      "floating_length": 24
    }
  ],
  "attributes": [
    {
      "key": "aws_account",
      "value": "admin-bob"
    }
  ],
  "permissions": [
    "licenses-manage"
  ],
  "source": "string",
  "mfa": {
    "status": "ENABLED",
    "seed": {
      "seed_string": "string",
      "seed_qr_code": "string"
    }
  },
  "stale_access_token": true,
  "authorized_keys": [
    {
      "id": "2765b005-4ce1-4b2b-a9ca-ee6c4d6f2792",
      "username": "joe@privx.com",
      "user_id": "f2f448d8-0397-4894-982f-9a58a43921db",
      "source": "5bf77342-221c-11ee-be56-0242ac120002",
      "name": "work",
      "comment": "Joe's work laptop key",
      "public_key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDqoMogqErOw7lL3GD6Ez7Hv1FZBk0Iyk2pBFUhqb9sjY9IEw8P9OWFwLMhWQ4LNvekPAnmr03pMHSSP7Pw98+Izy0HxcHZGKcrDOIjnHF5Fog3w4rBYa6OxdcJRxctifx5szqmM4JkUNS1RJY5E4ns4xCgFV46Satph02M+eP9PXGh+ZecSNtdLoOovVuolEUdb8dINgto8zsjEuAQ+76qOEgAIuSsYlzGGZPyPnATtkUi/rK9fcAfbhSqSXNxFqf7wejEKwA1kFt8hSW2bUWJH268fqnejFwHjBTzjBw89dji6141ajAP8/Q2gZug0bb1U70PE4afE3fFh2VCfhwT",
      "not_before": "2020-07-31T17:32:28Z",
      "not_after": "2022-07-31T17:32:28Z",
      "expires_in": 123,
      "source_address": [
        "192.168.100.0/24"
      ],
      "fingerprints": [
        "SHA256:bdeYZ2qiEwCOCuf0oTvya/aH4Vo+nJLIauDKm/D8btM"
      ]
    }
  ],
  "webauthn_credentials": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "credential_id": "string",
      "name": "string",
      "comment": "string",
      "last_used": "2017-01-01T15:05:05Z",
      "created": "2017-01-01T15:05:05Z",
      "author": "5bf77342-221c-11ee-be56-0242ac120002",
      "updated": "2017-01-01T15:05:05Z",
      "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
    }
  ]
}
get/role-store/api/v1/users/{user_id}/roles

Get a user's roles

Get specific user's roles.

user_idstring

required

User ID

Responses

Response examples

Successful response, returns user's role IDs & indication if the role is explicitly granted or implicitly mapped

{
  "count": 123,
  "items": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "name": "string",
      "comment": "A comment",
      "principal_public_key_strings": [
        "string"
      ],
      "permit_agent": true,
      "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "permissions": [
        "licenses-manage"
      ],
      "context": {
        "enabled": true,
        "block_role": true,
        "validity": [
          "MON"
        ],
        "start_time": "string",
        "end_time": "string",
        "timezone": "string",
        "ip_masks": [
          "string"
        ]
      },
      "explicit": true,
      "implicit": true,
      "system": true,
      "grant_type": "PERMANENT",
      "grant_validity_periods": [
        {
          "grant_start": "2017-01-01T15:05:05Z",
          "grant_end": "2017-01-02T15:05:05Z"
        }
      ],
      "floating_length": 24
    }
  ]
}
put/role-store/api/v1/users/{user_id}/roles

Update a user's roles

Set specific user's roles. These are granted in addition to mapped roles.

Array of objects

idstring
Format
uuid
namestring
commentstring

A comment describing the object

Example
"A comment"
principal_public_key_stringsarray

Principal public keys, returned only from /users/resolve

permit_agentboolean

Permit agent, returned only from /users/resolve

access_group_idstring

Scopes host and connection permissions to an access group

Format
uuid
permissionsarray

Array of permissions

PrivX permission

Enum
  • licenses-manage
  • api-clients-manage
  • idp-clients-view
  • idp-clients-manage
  • connections-view
  • connections-manage
  • connections-playback
  • connections-terminate
  • connections-manual
  • connections-trail
  • connections-authorize
  • ueba-view
  • ueba-manage
  • hosts-view
  • hosts-manage
  • privx-host-provisioning
  • network-targets-view
  • network-targets-manage
  • role-target-resources-view
  • role-target-resources-manage
  • roles-view
  • roles-manage
  • sources-view
  • sources-manage
  • sources-data-push
  • users-view
  • users-manage
  • logs-view
  • logs-manage
  • workflows-manage
  • workflows-view
  • vault-manage
  • vault-add
  • access-groups-manage
  • workflows-requests-on-behalf
  • workflows-requests
  • authorized-keys-manage
  • settings-manage
  • settings-view
  • requests-view
  • certificates-view
  • webauthn-credentials-manage
  • mobilegw-view
  • mobilegw-manage
  • target-domains-view
  • target-domains-manage
contextobject (contextual_limitation)

Contextual limitation

explicitboolean

Is the role explicitly granted to the user

Default
false
implicitboolean

Has the user implicitly gained the role or not.

Default
false
systemboolean
Default
false
grant_typestring

Is the role granted permanently, or is the grant time restricted, or a floating window. The floating window starts upon initial connection at which time the Role Store converts the floating window to explicit time-restricted window.

Enum
  • PERMANENT
  • TIME_RESTRICTED
  • FLOATING
grant_validity_periodsarray

Array of validity periods for this role. This array replaces grant_start and grant_end attributes in role object.

floating_lengthint

Duration for which the grant should last after initial connection, specified in hours

Example
24

Responses

Request examples

[
  {
    "id": "5bf77342-221c-11ee-be56-0242ac120002",
    "name": "string",
    "comment": "A comment",
    "principal_public_key_strings": [
      "string"
    ],
    "permit_agent": true,
    "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "permissions": [
      "licenses-manage"
    ],
    "context": {
      "enabled": true,
      "block_role": true,
      "validity": [
        "MON"
      ],
      "start_time": "string",
      "end_time": "string",
      "timezone": "string",
      "ip_masks": [
        "string"
      ]
    },
    "explicit": true,
    "implicit": true,
    "system": true,
    "grant_type": "PERMANENT",
    "grant_validity_periods": [
      {
        "grant_start": "2017-01-01T15:05:05Z",
        "grant_end": "2017-01-02T15:05:05Z"
      }
    ],
    "floating_length": 24
  }
]

Response examples

Successful response, user updated

Empty response

post/role-store/api/v1/users/mfa/enable

Enable MFA

Turn on multifactor authentication for an array of user IDs.

Array of strings

Format
uuid

Responses

Request examples

[
  "5bf77342-221c-11ee-be56-0242ac120002"
]

Response examples

Successful response, MFA turned on for the requested user IDs

Empty response

post/role-store/api/v1/users/mfa/disable

Disable MFA

Turn off multifactor authentication for an array of user IDs

Array of strings

Format
uuid

Responses

Request examples

[
  "5bf77342-221c-11ee-be56-0242ac120002"
]

Response examples

Successful response, MFA turned off for the requested user IDs

Empty response

post/role-store/api/v1/users/mfa/reset

Reset MFA

Reset multifactor authentication for an array of user IDs

Array of strings

Format
uuid

Responses

Request examples

[
  "5bf77342-221c-11ee-be56-0242ac120002"
]

Response examples

Successful response, MFA turned to uninitialized state for the requested user IDs

Empty response

get/role-store/api/v1/users/current

Get current user

Get current user and user's settings.

Authorizationstring

required

OAuth2 token

Default
"Bearer a-proper-token-goes-here"

Responses

Response examples

Successful response, returns the user.

{
  "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "source_user_id": null,
  "created": "2017-01-01T15:05:05Z",
  "updated": "2017-01-01T15:05:05Z",
  "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "author": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "comment": "A comment",
  "tags": [
    "string"
  ],
  "principal": "string",
  "distinguished_name": "string",
  "given_name": "string",
  "full_name": "string",
  "job_title": "string",
  "company": "string",
  "department": "string",
  "email": "string",
  "telephone": "string",
  "locale": "fi_FI",
  "roles": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "name": "string",
      "comment": "A comment",
      "principal_public_key_strings": [
        "string"
      ],
      "permit_agent": true,
      "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "permissions": [
        "licenses-manage"
      ],
      "context": {
        "enabled": true,
        "block_role": true,
        "validity": [
          "MON"
        ],
        "start_time": "string",
        "end_time": "string",
        "timezone": "string",
        "ip_masks": [
          "string"
        ]
      },
      "explicit": true,
      "implicit": true,
      "system": true,
      "grant_type": "PERMANENT",
      "grant_validity_periods": [
        {
          "grant_start": "2017-01-01T15:05:05Z",
          "grant_end": "2017-01-02T15:05:05Z"
        }
      ],
      "floating_length": 24
    }
  ],
  "attributes": [
    {
      "key": "aws_account",
      "value": "admin-bob"
    }
  ],
  "permissions": [
    "licenses-manage"
  ],
  "source": "string",
  "mfa": {
    "status": "ENABLED",
    "seed": {
      "seed_string": "string",
      "seed_qr_code": "string"
    }
  },
  "stale_access_token": true,
  "authorized_keys": [
    {
      "id": "2765b005-4ce1-4b2b-a9ca-ee6c4d6f2792",
      "username": "joe@privx.com",
      "user_id": "f2f448d8-0397-4894-982f-9a58a43921db",
      "source": "5bf77342-221c-11ee-be56-0242ac120002",
      "name": "work",
      "comment": "Joe's work laptop key",
      "public_key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDqoMogqErOw7lL3GD6Ez7Hv1FZBk0Iyk2pBFUhqb9sjY9IEw8P9OWFwLMhWQ4LNvekPAnmr03pMHSSP7Pw98+Izy0HxcHZGKcrDOIjnHF5Fog3w4rBYa6OxdcJRxctifx5szqmM4JkUNS1RJY5E4ns4xCgFV46Satph02M+eP9PXGh+ZecSNtdLoOovVuolEUdb8dINgto8zsjEuAQ+76qOEgAIuSsYlzGGZPyPnATtkUi/rK9fcAfbhSqSXNxFqf7wejEKwA1kFt8hSW2bUWJH268fqnejFwHjBTzjBw89dji6141ajAP8/Q2gZug0bb1U70PE4afE3fFh2VCfhwT",
      "not_before": "2020-07-31T17:32:28Z",
      "not_after": "2022-07-31T17:32:28Z",
      "expires_in": 123,
      "source_address": [
        "192.168.100.0/24"
      ],
      "fingerprints": [
        "SHA256:bdeYZ2qiEwCOCuf0oTvya/aH4Vo+nJLIauDKm/D8btM"
      ]
    }
  ],
  "webauthn_credentials": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "credential_id": "string",
      "name": "string",
      "comment": "string",
      "last_used": "2017-01-01T15:05:05Z",
      "created": "2017-01-01T15:05:05Z",
      "author": "5bf77342-221c-11ee-be56-0242ac120002",
      "updated": "2017-01-01T15:05:05Z",
      "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
    }
  ]
}
get/role-store/api/v1/users/current/awsroles

Get current user's AWS roles

Get current user's AWS roles.

Authorizationstring

required

OAuth2 token

Default
"Bearer a-proper-token-goes-here"

Responses

Response examples

Successful response, returns the AWS roles.

{
  "count": 123,
  "items": [
    {
      "id": "514510fe-1531-530f-63c6-3f80cea33fdc",
      "name": "My Own AWS Role",
      "arn": "arn:aws:iam::123456789012:role/role-name",
      "updated": "2017-01-01T15:05:05Z",
      "description": "string",
      "source": "514510fe-1531-530f-63c6-3f80cea33fdc",
      "status": "OK",
      "roles": [
        {
          "id": "5bf77342-221c-11ee-be56-0242ac120002",
          "name": "string"
        }
      ]
    }
  ]
}
get/role-store/api/v1/users/current/settings

Get current user's settings

Get current user settings.

Authorizationstring

required

OAuth2 token

Default
"Bearer a-proper-token-goes-here"

Responses

Response examples

Successful response, returns the user.

{}
put/role-store/api/v1/users/current/settings

Update current user's settings

Update current user's settings.

Responses

Request examples

{}

Response examples

Successful request. Settings object must be a valid JSON object with any attributes.

{}
get/role-store/api/v1/users/{user_id}/resolve

Resolve user's roles

Resolve user's roles

user_idstring

required

Responses

Response examples

Return the found user object

{
  "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "source_user_id": null,
  "created": "2017-01-01T15:05:05Z",
  "updated": "2017-01-01T15:05:05Z",
  "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "author": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "comment": "A comment",
  "tags": [
    "string"
  ],
  "principal": "string",
  "distinguished_name": "string",
  "given_name": "string",
  "full_name": "string",
  "job_title": "string",
  "company": "string",
  "department": "string",
  "email": "string",
  "telephone": "string",
  "locale": "fi_FI",
  "roles": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "name": "string",
      "comment": "A comment",
      "principal_public_key_strings": [
        "string"
      ],
      "permit_agent": true,
      "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "permissions": [
        "licenses-manage"
      ],
      "context": {
        "enabled": true,
        "block_role": true,
        "validity": [
          "MON"
        ],
        "start_time": "string",
        "end_time": "string",
        "timezone": "string",
        "ip_masks": [
          "string"
        ]
      },
      "explicit": true,
      "implicit": true,
      "system": true,
      "grant_type": "PERMANENT",
      "grant_validity_periods": [
        {
          "grant_start": "2017-01-01T15:05:05Z",
          "grant_end": "2017-01-02T15:05:05Z"
        }
      ],
      "floating_length": 24
    }
  ],
  "attributes": [
    {
      "key": "aws_account",
      "value": "admin-bob"
    }
  ],
  "permissions": [
    "licenses-manage"
  ],
  "source": "string",
  "mfa": {
    "status": "ENABLED",
    "seed": {
      "seed_string": "string",
      "seed_qr_code": "string"
    }
  },
  "stale_access_token": true,
  "authorized_keys": [
    {
      "id": "2765b005-4ce1-4b2b-a9ca-ee6c4d6f2792",
      "username": "joe@privx.com",
      "user_id": "f2f448d8-0397-4894-982f-9a58a43921db",
      "source": "5bf77342-221c-11ee-be56-0242ac120002",
      "name": "work",
      "comment": "Joe's work laptop key",
      "public_key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDqoMogqErOw7lL3GD6Ez7Hv1FZBk0Iyk2pBFUhqb9sjY9IEw8P9OWFwLMhWQ4LNvekPAnmr03pMHSSP7Pw98+Izy0HxcHZGKcrDOIjnHF5Fog3w4rBYa6OxdcJRxctifx5szqmM4JkUNS1RJY5E4ns4xCgFV46Satph02M+eP9PXGh+ZecSNtdLoOovVuolEUdb8dINgto8zsjEuAQ+76qOEgAIuSsYlzGGZPyPnATtkUi/rK9fcAfbhSqSXNxFqf7wejEKwA1kFt8hSW2bUWJH268fqnejFwHjBTzjBw89dji6141ajAP8/Q2gZug0bb1U70PE4afE3fFh2VCfhwT",
      "not_before": "2020-07-31T17:32:28Z",
      "not_after": "2022-07-31T17:32:28Z",
      "expires_in": 123,
      "source_address": [
        "192.168.100.0/24"
      ],
      "fingerprints": [
        "SHA256:bdeYZ2qiEwCOCuf0oTvya/aH4Vo+nJLIauDKm/D8btM"
      ]
    }
  ],
  "webauthn_credentials": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "credential_id": "string",
      "name": "string",
      "comment": "string",
      "last_used": "2017-01-01T15:05:05Z",
      "created": "2017-01-01T15:05:05Z",
      "author": "5bf77342-221c-11ee-be56-0242ac120002",
      "updated": "2017-01-01T15:05:05Z",
      "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
    }
  ]
}
post/role-store/api/v1/users/search

Find users

Find users with user search parameters.

keywordsstring

Search string, URL encoded

user_idarray

List of users IDs.

sourcestring

The source ID where to search the user from

Responses

Request examples

{
  "keywords": "string",
  "user_id": [
    "string"
  ],
  "source": "string"
}

Response examples

Successful response, returns a list of users

{
  "count": 123,
  "items": [
    {
      "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "source_user_id": null,
      "created": "2017-01-01T15:05:05Z",
      "updated": "2017-01-01T15:05:05Z",
      "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "author": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "comment": "A comment",
      "tags": [
        "string"
      ],
      "principal": "string",
      "distinguished_name": "string",
      "given_name": "string",
      "full_name": "string",
      "job_title": "string",
      "company": "string",
      "department": "string",
      "email": "string",
      "telephone": "string",
      "locale": "fi_FI",
      "roles": [
        {
          "id": "5bf77342-221c-11ee-be56-0242ac120002",
          "name": "string",
          "comment": "A comment",
          "principal_public_key_strings": [
            "string"
          ],
          "permit_agent": true,
          "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
          "permissions": [
            "licenses-manage"
          ],
          "context": {
            "enabled": true,
            "block_role": true,
            "validity": [
              "MON"
            ],
            "start_time": "string",
            "end_time": "string",
            "timezone": "string",
            "ip_masks": [
              "string"
            ]
          },
          "explicit": true,
          "implicit": true,
          "system": true,
          "grant_type": "PERMANENT",
          "grant_validity_periods": [
            {
              "grant_start": "2017-01-01T15:05:05Z",
              "grant_end": "2017-01-02T15:05:05Z"
            }
          ],
          "floating_length": 24
        }
      ],
      "attributes": [
        {
          "key": "aws_account",
          "value": "admin-bob"
        }
      ],
      "permissions": [
        "licenses-manage"
      ],
      "source": "string",
      "mfa": {
        "status": "ENABLED",
        "seed": {
          "seed_string": "string",
          "seed_qr_code": "string"
        }
      },
      "stale_access_token": true,
      "authorized_keys": [
        {
          "id": "2765b005-4ce1-4b2b-a9ca-ee6c4d6f2792",
          "username": "joe@privx.com",
          "user_id": "f2f448d8-0397-4894-982f-9a58a43921db",
          "source": "5bf77342-221c-11ee-be56-0242ac120002",
          "name": "work",
          "comment": "Joe's work laptop key",
          "public_key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDqoMogqErOw7lL3GD6Ez7Hv1FZBk0Iyk2pBFUhqb9sjY9IEw8P9OWFwLMhWQ4LNvekPAnmr03pMHSSP7Pw98+Izy0HxcHZGKcrDOIjnHF5Fog3w4rBYa6OxdcJRxctifx5szqmM4JkUNS1RJY5E4ns4xCgFV46Satph02M+eP9PXGh+ZecSNtdLoOovVuolEUdb8dINgto8zsjEuAQ+76qOEgAIuSsYlzGGZPyPnATtkUi/rK9fcAfbhSqSXNxFqf7wejEKwA1kFt8hSW2bUWJH268fqnejFwHjBTzjBw89dji6141ajAP8/Q2gZug0bb1U70PE4afE3fFh2VCfhwT",
          "not_before": "2020-07-31T17:32:28Z",
          "not_after": "2022-07-31T17:32:28Z",
          "expires_in": 123,
          "source_address": [
            "192.168.100.0/24"
          ],
          "fingerprints": [
            "SHA256:bdeYZ2qiEwCOCuf0oTvya/aH4Vo+nJLIauDKm/D8btM"
          ]
        }
      ],
      "webauthn_credentials": [
        {
          "id": "5bf77342-221c-11ee-be56-0242ac120002",
          "credential_id": "string",
          "name": "string",
          "comment": "string",
          "last_used": "2017-01-01T15:05:05Z",
          "created": "2017-01-01T15:05:05Z",
          "author": "5bf77342-221c-11ee-be56-0242ac120002",
          "updated": "2017-01-01T15:05:05Z",
          "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
        }
      ]
    }
  ]
}
post/role-store/api/v1/users/search/external

Find users by external ID

Find users with external user search parameters.

keywordsstring

Search string, URL encoded

user_idarray

List of users IDs.

sourcestring

The source ID where to search the user from

Responses

Request examples

{
  "keywords": "string",
  "user_id": [
    "string"
  ],
  "source": "string"
}

Response examples

Successful response, returns a list of users

{
  "count": 123,
  "items": [
    {
      "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "source_user_id": null,
      "created": "2017-01-01T15:05:05Z",
      "updated": "2017-01-01T15:05:05Z",
      "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "author": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "comment": "A comment",
      "tags": [
        "string"
      ],
      "principal": "string",
      "distinguished_name": "string",
      "given_name": "string",
      "full_name": "string",
      "job_title": "string",
      "company": "string",
      "department": "string",
      "email": "string",
      "telephone": "string",
      "locale": "fi_FI",
      "roles": [
        {
          "id": "5bf77342-221c-11ee-be56-0242ac120002",
          "name": "string",
          "comment": "A comment",
          "principal_public_key_strings": [
            "string"
          ],
          "permit_agent": true,
          "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
          "permissions": [
            "licenses-manage"
          ],
          "context": {
            "enabled": true,
            "block_role": true,
            "validity": [
              "MON"
            ],
            "start_time": "string",
            "end_time": "string",
            "timezone": "string",
            "ip_masks": [
              "string"
            ]
          },
          "explicit": true,
          "implicit": true,
          "system": true,
          "grant_type": "PERMANENT",
          "grant_validity_periods": [
            {
              "grant_start": "2017-01-01T15:05:05Z",
              "grant_end": "2017-01-02T15:05:05Z"
            }
          ],
          "floating_length": 24
        }
      ],
      "attributes": [
        {
          "key": "aws_account",
          "value": "admin-bob"
        }
      ],
      "permissions": [
        "licenses-manage"
      ],
      "source": "string",
      "mfa": {
        "status": "ENABLED",
        "seed": {
          "seed_string": "string",
          "seed_qr_code": "string"
        }
      },
      "stale_access_token": true,
      "authorized_keys": [
        {
          "id": "2765b005-4ce1-4b2b-a9ca-ee6c4d6f2792",
          "username": "joe@privx.com",
          "user_id": "f2f448d8-0397-4894-982f-9a58a43921db",
          "source": "5bf77342-221c-11ee-be56-0242ac120002",
          "name": "work",
          "comment": "Joe's work laptop key",
          "public_key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDqoMogqErOw7lL3GD6Ez7Hv1FZBk0Iyk2pBFUhqb9sjY9IEw8P9OWFwLMhWQ4LNvekPAnmr03pMHSSP7Pw98+Izy0HxcHZGKcrDOIjnHF5Fog3w4rBYa6OxdcJRxctifx5szqmM4JkUNS1RJY5E4ns4xCgFV46Satph02M+eP9PXGh+ZecSNtdLoOovVuolEUdb8dINgto8zsjEuAQ+76qOEgAIuSsYlzGGZPyPnATtkUi/rK9fcAfbhSqSXNxFqf7wejEKwA1kFt8hSW2bUWJH268fqnejFwHjBTzjBw89dji6141ajAP8/Q2gZug0bb1U70PE4afE3fFh2VCfhwT",
          "not_before": "2020-07-31T17:32:28Z",
          "not_after": "2022-07-31T17:32:28Z",
          "expires_in": 123,
          "source_address": [
            "192.168.100.0/24"
          ],
          "fingerprints": [
            "SHA256:bdeYZ2qiEwCOCuf0oTvya/aH4Vo+nJLIauDKm/D8btM"
          ]
        }
      ],
      "webauthn_credentials": [
        {
          "id": "5bf77342-221c-11ee-be56-0242ac120002",
          "credential_id": "string",
          "name": "string",
          "comment": "string",
          "last_used": "2017-01-01T15:05:05Z",
          "created": "2017-01-01T15:05:05Z",
          "author": "5bf77342-221c-11ee-be56-0242ac120002",
          "updated": "2017-01-01T15:05:05Z",
          "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
        }
      ]
    }
  ]
}

Was this page helpful?