POST OAuth/DeleteRules

Deletes all rules for a given user or application. To delete just a specific user's role from a given application, call POST OAuth/DeleteRule.

Requirements

  • Roles: Admin or Application Owner. See OAuth roles for more information.
  • Token scope:  Admin

Headers

  • Content type: Content-Type:application/json.

  • Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.

Parameters

NOTE  At least one parameter is required.

Body parameters

Name

Description

TrusteePrefixedUniversal

string

The prefixed universal of the identity whose rules are being deleted. Passing only this parameter deletes all rules for this identity.

ApplicationId

string

The ID of the application the rules are being deleted from. Passing only this parameter deletes all rules for this application.

Returns

Response description

Name

Description

HTTP 200

See OAuth result codes.

HTTP 400

For invalid requests, this call returns HTTP 400 Bad Request and the following data in the message body:

  • Error

    • invalid_request: The request is missing a required parameter or is otherwise malformed.

  • Error_description: If available, additional information about how to retry the request.

HTTP 401

For authentication errors, this call returns HTTP 401 Unauthorized and the following data in the message body:

  • Error

    • invalid_token: The access token is missing, or the provided token is expired, revoked, malformed, or invalid for other reasons.

    • insufficient_rights: The underlying user account does not have sufficient permissions for this request.

  • error_description: If available, additional information about how to retry the request.

HTTP 403

If the response is HTTP 403 Forbidden, the requester's token does not include the admin scope. Call POST Authorize/Oauth with the correct scope and restriction. Update the header with the new token and retry.

  • Error

    • insufficient_scope: The request requires a greater scope than provided by the access token.

  • error_description: If available, additional information about how to retry the request.

Example

Request

POST /vedsdk/oauth/deleterules HTTP/1.1
Host: tpp-server-url
Content-Type: application/json
Accept: application/json
Authorization: Bearer 4MyGeneratedBearerTknz==

{
  "TrusteePrefixedUniversal": "local:{7879a929-157c-479e-b81a-350661aa7d45}"
}

Response

{
  "Result": 0,
  "Success": true
}