Deny Authorization

An authorization in Pended status can be denied using the Deny Authorization operation.

When an authorization is in Pended status, a Deny link is added to the authorization resource.

The table below gives an overview:

Table 1. Deny link for an authorization status
Status of the authorization Link Resource Available

Entry

No

In Process

No

Pended

Yes

Changed

No

Approved

No

Denied

No

 
{
  "links":
 [
  {
    "href": "http://[hostName]:[portNumber]/[api-context-root]/generic/authorizations/{id}",
    "rel": "self"
  },
  {
    "href": "http://[hostName]:[portNumber]/[api-context-root]/authorizations/{id}/deny",
    "rel": "authorization:deny",
    "httpMethod": "POST"
  }
 ]
}

When a client uses this link, the client must attach a fatal message. Clients must send one authorization fatal message in the POST payload:

{
  "authorizationmessage":
  {
    "message":
    {
      "id": "<id of message>"
    }
  }
}

Without a fatal message, HTTP status 400 (Bad Request) is returned.

Operation

  • The status of the authorization changes to Denied.

  • The system creates authorization status history for the status change.

  • The system creates authorization pend history records for all pend reasons attached to the authorization.

    • The resolved by and resolved date time attributes of the authorization pend history records of the most recent authorization status history for Pended status are not set because they are not yet resolved.

  • Pend reasons are removed, and the pend history corresponding to the authorization status history for the current Pended process step is updated to resolved.

  • If an open work item is linked to the authorization in any status other than Done, the system closes the current work item and updates work item history.

    • If the open work item is on hold (ind_hold = Y), the system releases the hold and updates hold history before closing the work item.

    • For more information, see Work Item Creation and Closure.

  • HTTP status 201 is returned with a representation of the authorization resource.

  • The response header includes a redirect link to the authorization.

Authorization

The operation in this section is protected by access restriction "authorization.deny IP". A grant must be given with create, read and update flag set. A Read grant must also be given to access restriction "authorizations API".

Response Message

The following are failure messages:

Table 2. Response Messages
Response Description

AUT-IP-AUTO-001

Authorization id {id} is unknown

AUT-IP-AUTI-024

Authorizations in status {status} cannot be Denied

AUT-IP-AUTI-013

Message code {0} is unknown

For more information, see Response Messages.