Skip to main content
Version: 3.5 Stable

Clear member roles

Clear all roles of a member in a PhoenixAI Cloud account.

NOTE

  • You cannot modify roles for the creator of an account.
  • The system-defined role Public cannot be revoked from a member.
  • This operation requires the Member Management privilege.

Request​

Basic Information
HTTP URLhttps://cloud-api.celerdata.com/api/1.0/users/:user_id/clear-roles
HTTP MethodPOST
Frequency600/minute

Path variables​

ParameterExample valueRequiredTypeDescription
user_id9d71aae6-a35d-40d5-b213-27bb1f583be5YesStringThe ID of the member.

Header parameters​

ParameterExample valueRequiredTypeDescription
AuthorizationBearer OGQ5MDA4MZGTNJMWNS0ZY2Y2LWFJNZYTOTBINMZIYTGZZDUYYesStringThe access token used to access the PhoenixAI Cloud API. Format: Bearer <access_token>.

See Obtain access token.

Response​

Sample response​

{
"code": 20000,
"data": {
"succeed": true
}
}

Response elements​

ParameterExample valueTypeDescription
code20000IntegerThe error code. If the error code returned is 20000, the request succeeded. If any other error code is returned, the request failed.
data-ObjectThe result of the API call.
data.succeedtrueBooleanWhether the role clearing operation succeeded. Valid values:
  • true: The operation succeeded.
  • false: The operation failed.
data.err_msg-StringThe error message of the role clearing operation. This element is returned only when data.succeed is false.
message-StringThe error message. This element is returned only when the code returned is not 20000.
NOTICE
Do not conclude whether a request succeeded or failed based on the return value of message.