POST OAuth/DeleteRule

Deletes a rule for a specific user from a given application. To delete all rules for a user or an application, call POST OAuth/DeleteRules.

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

IMPORTANT  Both parameters are required to delete just one user's rule from an application. Passing only TrusteePrefixedUniversal will delete all the user's rules for all applications. Passing only ApplicationId will delete all rules for the application.

Body parameters

Name

Description

TrusteePrefixedUniversal

string

(Required) The prefixed universal of the identity whose rule is being deleted.

ApplicationId

string

(Required) The application ID of the application the rule is being deleted from.

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/DeleteRule HTTP/1.1
Host: tpp-server-url
Content-Type: application/json
Accept: application/json
Authorization: Bearer 4MyGeneratedBearerTknz==

{
  "TrusteePrefixedUniversal": "local:{5be5a591-c842-4520-9142-b455f4ad2286}",
  "ApplicationId": "VenafiMMCEventViewer"
}

Response

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