• Identity and Access Management

iam
  1. Help Center
  2. Identity and Access Management
  3. API Reference
  4. Agency Management
  5. Deleting an Agency

Deleting an Agency

Function Description

This interface is used to delete an agency.

This interface applies only to accesses using domain names of the global zone.

URI

  • URI format

    DELETE /v3.0/OS-AGENCY/agencies/{agency_id}

  • URI parameter description

    Parameter

    Mandatory

    Type

    Description

    agency_id

    Yes

    String

    ID of an agency.

Request

  • Request header parameter description

    Parameter

    Mandatory

    Type

    Description

    Content-Type

    Yes

    String

    Fill application/json;charset=utf8 in this field.

    X-Auth-Token

    Yes

    String

    Authenticated token with the Security Administrator permission.

  • Sample request
    curl -i -k -H "X-Auth-Token:$token" -H 'Content-Type:application/json;charset=utf8' -X DELETE https://sample.domain.com/v3.0/OS-AGENCY/agencies/2809756f748a46e2b92d58d309f67291

Response

  • Sample response (request failed)
    {
        "error": {
            "message": "Could not find agency: 2809756f748a46e2b92d58d309f67291",
            "code": 404,
            "title": "Not Found"
        }
    }

Status Codes

Status Code

Description

204

The request is successful.

401

You must enter a username and password to access the requested page.

403

You are forbidden to access the requested page.

404

The server could not find the requested page.

500

Failed to complete the request because of an internal service error.