API7 Docs
API7 GatewayAPI7 Enterprise Admin APIsDelete a login option

Delete a login option

DELETE /api/login_options/{login_option_id}

DELETE /api/login_options/{login_option_id}

Interactive request editor loads with JavaScript.

Authorization

X-API-KEY<token>

In: header

Path Parameters

login_option_id*string

Login option ID.

Response Body

application/json

curl -X DELETE "$API_BASE_URL/api/login_options/string"

Successful operation.

{
  "value": {}
}
Complete operation details and schema variants

DELETE /api/login_options/{login_option_id}

Delete a login option

Delete a login option and remove that authentication method from available sign-in choices. Required IAM Permission: Action iam:DeleteLoginOption, Resource arn:api7:iam:organization/*

Parameters

  • login_option_id (path, string, required): Login option ID.

Responses

  • 200: Successful operation.
  • value (object, optional): The specific resource.
  • 400: Invalid arguments. Error details will be provided in the response.

cURL

curl -X DELETE '$API_BASE_URL/api/login_options/{login_option_id}'