Skip to content

Identity Provider Users

Get list of identity provider users

GET/api/v1/Owners/{ownerAccountId}/IdentityProviders/{ipId}/Users

Get a list of all registered users of the specified identity provider.

Scope

read:ip:users

Parameters

Name Type Location Description
ownerAccountId string path The owner account's ID.
ipId string path The identity provider ID as generated during the registration process.

Success Response

200 OK
[
  {
    "id": "1",
    "ipId": "1",
    "ipUserId": "abc",
    "identifier": null,
    "status": "Normal"
  },
  {
    "id": "2",
    "ipId": "1",
    "ipUserId": "def",
    "identifier": null,
    "status": "Normal"
  }
]

Error Responses

HTTP Status Code Error Code Description
400 Generic Error
401 Unauthorized
403 Forbidden

Get user by Tapkey user ID

GET/api/v1/Owners/{ownerAccountId}/IdentityProviders/{ipId}/Users/{id}

Get a registered user of the specified identity provider by Tapkey user ID.

Scope

read:ip:users

Parameters

Name Type Location Description
ownerAccountId string path The owner account's ID.
ipId string path The identity provider ID as generated during the registration process.
id string path The user ID as generated by Tapkey.

Success Response

200 OK
{
  "id": "1",
  "ipId": "1",
  "ipUserId": "abc",
  "identifier": null,
  "status": "Normal"
}

Error Responses

HTTP Status Code Error Code Description
400 Generic Error
401 Unauthorized
403 Forbidden
404 User not found

Get user by identity provider user ID

GET/api/v1/Owners/{ownerAccountId}/IdentityProviders/{ipId}/Users?ipUserId={ipUserId}

Get a registered user of the specified identity provider by identity provider user ID.

Scope

read:ip:users

Parameters

Name Type Location Description
ownerAccountId string path The owner account's ID.
ipId string path The identity provider ID as generated during the registration process.
ipUserId string query The user ID coming from the external identity provider.

Success Response

200 OK
{
  "id": "1",
  "ipId": "1",
  "ipUserId": "abc",
  "identifier": null,
  "status": "Normal"
}

Error Responses

HTTP Status Code Error Code Description
400 Generic Error
401 Unauthorized
403 Forbidden
404 User not found

Create identity provider user

PUT/api/v1/Owners/{ownerAccountId}/IdentityProviders/{ipId}/Users

Create a new user for the specified identity provider.

Scope

write:ip:users

Parameters

Name Type Location Description
ownerAccountId string path The owner account's ID.
ipId string path The identity provider ID as generated during the registration process.

Body

{
  "ipId": "1",
  "ipUserId": "abc"
}

Success Response

200 OK
{
  "id": "1",
  "ipId": "1",
  "ipUserId": "abc",
  "identifier": null,
  "status": "Normal"
}

Info

The ipId in the post body is optional. If specified, it must match the one in the path parameter.

Warning

This operation will fail with 400 - User already exists when calling again with the same parameters and body.

Error Responses

HTTP Status Code Error Code Description
400 Generic Error
401 Unauthorized
403 Forbidden
404 IdentityProviderNotFound Unknown identity provider
409 NothingToDo User already exists