Update User Remove Roles

Remove roles from an existing user, using a valid management key.

This API endpoint allows you to remove roles from a user granularly without updating all user details.

roleNames is an array of the role names in string format.

The tenantId is optional; if provided, the user must be a member of that tenant

The response returns the user's details in json format.

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer <ProjectId:ManagementKey>

SecurityAuthProjectIdMgmtKey

Request

Request Body schema: application/json
required

loginId	string
tenantId	string
roleNames	Array of strings

Responses

200

post/v1/mgmt/user/update/role/remove

Request samples

curl

Response samples

application/json

{"user": {"loginIds": ["string"
],
"userId": "string",
"name": "string",
"email": "string",
"phone": "string",
"verifiedEmail": true,
"verifiedPhone": true,
"roleNames": ["string"
],
"userTenants": [{"tenantId": "string",
"roleNames": ["string"
],
"tenantName": "string"
}
],
"status": "string",
"externalIds": ["string"
],
"picture": "string",
"test": false,
"customAttributes": { },
"createdTime": 0,
"TOTP": false,
"SAML": false,
"OAuth": {"property1": false,
"property2": false
},
"webauthn": true,
"password": true,
"ssoAppIds": ["string"
],
"givenName": "string",
"middleName": "string",
"familyName": "string",
"editable": true
}
}