API Authorization Resource

This is the base resource for configuring api authorization in OneLogin.

Resource Elements

{
  "id": 1022697,
  "name": "Contacts API",
  "description": "This is an api",
  "configuration": {
    "resource_identifier": "https://example.com/contacts",
    "audiences": [
      "https://example.com/contacts"
    ],
    "refresh_token_expiration_minutes": 30,
    "access_token_expiration_minutes": 10
  }
}
```xml

<table width="100%" border="0" cellpadding="10">
  <tbody>
    <tr>
      <td style="text-align: right" width="20%">
        <p>id</p>
        <p>integer</p>
      </td>
      <td>Auth Server unique ID in OneLogin.</td>
    </tr>
    <tr>
      <td style="text-align: right">
        <p>name</p>
        <p style="color: #FF0004">required</p>
        <p>string</p>
      </td>
      <td>Name of the API.</td>
    </tr>
    <tr>
      <td style="text-align: right">
        <p>description</p>
        <p style="color: #FF0004">required</p>
        <p>string</p>
      </td>
      <td>Description of what the API does.</td>
    </tr>
    <tr>
      <td style="text-align: right">
        <p>configuration</p>
        <p style="color: #FF0004">required</p>
        <p>object</p>
      </td>
      <td>
        <i>See configuration section below.</i>
      </td>
    </tr>
  </tbody>
</table>

### Configuration

<table width="100%" border="0" cellpadding="10">
  <tbody>
    <tr>
      <td style="text-align: right" width="20%">
        <p>resource_identifier</p>
        <p style="color: #FF0004">required</p>
        <p>string</p>
      </td>
      <td>Unique identifier for the API that the Authorization Server will issue Access Tokens for.
        <p>ex. http://example.com/contacts</p>
      </td>
    </tr>
    <tr>
      <td style="text-align: right">
        <p>audiences</p>
        <p style="color: #FF0004">required</p>
        <p>array</p>
      </td>
      <td>List of API endpoints that will be returned in Access Tokens.
        <p>ex. http://example.com/contacts</p>
      </td>
    </tr>
    <tr>
      <td style="text-align: right">
        <p>access_token_expiration_minutes</p>
        <p>integer</p>
      </td>
      <td>The number of minutes until access token expires. There is no maximum expiry limit.</td>
    </tr>
    <tr>
      <td style="text-align: right">
        <p>refresh_token_expiration_minutes</p>
        <p>integer</p>
      </td>
      <td>The number of minutes until refresh token expires. There is no maximum expiry limit.</td>
    </tr>
  </tbody>
</table>

## Postman Collection

[<img src=https://run.pstmn.io/button.svg alt="Run In Postman" style="width: 128px; height: 32px;">](https://god.gw.postman.com/run-collection/2629710-48bfcc94-5095-460e-bb93-f5a6b0049c58?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D2629710-48bfcc94-5095-460e-bb93-f5a6b0049c58%26entityType%3Dcollection%26workspaceId%3D2a9bbc3a-4259-4faf-9f51-0b7ca1df3fd0)