DisableUserInIDM.

PUT

/api/web/namespaces/system/user/settings/idm/disable

curl --request PUT \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/web/namespaces/system/user/settings/idm/disable \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "user_email": "example" }'

• F5 Distributed Cloud Console

Disables user in Identity.

Examples of this operation.

Authorizations

• ApiToken

Request Body^required

Media typeapplication/json

Email

Email

object

user_email

Email

Configuration parameter for user email

string

<= 1024 characters

Example^generated

{
  "user_email": "example"
}

Responses

200

A successful response.

Media typeapplication/json

Empty

Empty object definition.

object

Example^generated

{}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example