Grant a User Identity Access to a Device

Grant a specified user identity access to a specified device

Grants a specified user identity access to a specified device.

You can only grant user identities access to managed devices.

/user_identities/grant_access_to_device

POSThttps://connect.getseam.com/user_identities/grant_access_to_device

Authorization

api_keypat_with_workspaceconsole_session

Body

application/json

user_identity_id*string (uuid)

device_id*string (uuid)

Response

200400401

OK

Body

application/json

ok*boolean

Request

JavaScriptCurlPython

const response = await fetch('https://connect.getseam.com/user_identities/grant_access_to_device', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API Key",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "user_identity_id": "123e4567-e89b-12d3-a456-426614174000",
      "device_id": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Response

200

{
  "ok": false
}

Request

Specify the desired user identity and device by including the corresponding user_identity_id and device_id in the request body.

Request Body Parameters

Parameter	Type	Description
user_identity_id	String Required	ID of the desired user identity
device_id	String Required	ID of the desired managed device

Sample Request

cURL (bash)

curl -X 'POST' \
  'https://connect.getseam.com/user_identities/grant_access_to_device' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer ${API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "user_identity_id": "f3a328b4-dd04-4370-9000-d52b7a01b0bf",
  "device_id": "054765c8-a2fc-4599-b486-14c19f462c45"
}'

Go

_, uErr := client.UserIdentities.GrantAccessToDevice(context.Background(), &api.UserIdentitiesGrantAccessToDeviceRequest{
    UserIdentityId: "f3a328b4-dd04-4370-9000-d52b7a01b0bf",
    DeviceId: "054765c8-a2fc-4599-b486-14c19f462c45",
})

if uErr != nil {
    return uErr
}

return nil

Response

Returns a Boolean ok status indicator.

Sample Response

JSON

{
  "ok": true
}