Revoke Client

Revoke Client
Revoke Oauth App Client.

Revoke Oauth App Client. You need to pass asset id or client id as input. Asset id/client id can be fetched from Oauth App search api.

Request
URI
POST
https://eapi.broadcom.com/vcf/tenant-mgmt/api/v1/auth/clients/revoke
COPY
Request Body
RevokeClientRequest of type(s) application/json
Required

Show optional properties

{
    "tenant_id": "string"
}
{
    "asset_id": "asset@test",
    "tenant_id": "567905de-ef1c-48ce-9e4e-05c28f5caaa6"
}
string
tenant_id
Required

Id of the owner tenant in which Oauth App is created

string
asset_id
Optional

Asset Id of Oauth App. Either Asset Id or Client Id must be provided. If both present Asset Id will be used to revoke the client associated with Asset Id.

string
client_id
Optional

Client Id of Oauth App. Either Client Id or Asset Id must be provided. If both present Asset Id will be used to revoke the client associated with Asset Id.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns RevokeClientResponse of type(s) application/json 
{
    "client_id": "94faf930-df7e-477d-b6fe-e80c9b049e30",
    "asset_id": "asset@test",
    "site_id": 67444,
    "tenant_id": "567905de-ef1c-48ce-9e4e-05c28f5caaa6",
    "revoked_by": "[email protected]"
}
string
tenant_id
Optional

Id of the owner tenant in which Oauth App is created

string
asset_id
Optional

Asset id of Oauth App

string
client_id
Optional

Client id of Oauth App

string
site_id
Optional

Site id.

string
revoked_by
Optional

Principal who revoked the Oauth App


400

Bad Request

Returns ErrorResponse of type(s) application/json 
{
    "value": {
        "major_error_code": "INVALID_ASSET_ID",
        "minor_error_code": "INVALID_ASSET_ID",
        "message": "Invalid Asset ID In the Request OR Asset is already revoked."
    }
}
array of string
parameter_list
Optional

parameter_list

string
message
Optional

message

string
major_error_code
Optional

major_error_code

string
minor_error_code
Optional

minor_error_code


401

Unauthorized

Returns ErrorResponse of type(s) application/json 
{
    "value": {
        "major_error_code": 401,
        "minor_error_code": "UNAUTHORIZED",
        "message": "Validation Failed. Reason: Token Expired"
    }
}
array of string
parameter_list
Optional

parameter_list

string
message
Optional

message

string
major_error_code
Optional

major_error_code

string
minor_error_code
Optional

minor_error_code


403

Forbidden

Returns ErrorResponse of type(s) application/json 
{
    "major_error_code": 403,
    "minor_error_code": "ACCESS_DENIED",
    "message": "Access Denied"
}
array of string
parameter_list
Optional

parameter_list

string
message
Optional

message

string
major_error_code
Optional

major_error_code

string
minor_error_code
Optional

minor_error_code


404

Not Found

Returns ErrorResponse of type(s) application/json 
{
    "value": {
        "major_error_code": "NOT_FOUND",
        "minor_error_code": "TENANT_NOT_FOUND",
        "message": "Tenant 567905de-ef1c-48ce-9e4e-05c28f5caaa6 not found."
    }
}
array of string
parameter_list
Optional

parameter_list

string
message
Optional

message

string
major_error_code
Optional

major_error_code

string
minor_error_code
Optional

minor_error_code


500

Internal Server Error

Returns ErrorResponse of type(s) application/json 
{
    "value": {
        "major_error_code": "FAILED_TO_REVOKE_ASSET",
        "minor_error_code": "FAILED_TO_REVOKE_ASSET",
        "message": "Failed to revoke asset."
    }
}
array of string
parameter_list
Optional

parameter_list

string
message
Optional

message

string
major_error_code
Optional

major_error_code

string
minor_error_code
Optional

minor_error_code


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"tenant_id:"string"}' https://{api_host}/vcf/tenant-mgmt/api/v1/auth/clients/revoke
On This Page
Oauth Apps Operations
POST
Search Oauth App
POST
Revoke Client
POST
Regenerate Client