# Authorization

An Authorization object is a business object that encapsulates the permissions and credentials necessary for interactions between a specific seller and vendors, all within the scope of a single product. It is associated with the seller via listings and serves as the repository for access control and provisioning data required for the vendor to deliver services or content.

This object contains the following attributes:

<table><thead><tr><th width="126">Field Name</th><th width="206">Data Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>string</td><td><p>The identifier for the authorization. </p><p>Example: AUT-1234-4678</p></td></tr><tr><td><code>name</code></td><td>string</td><td><p>The name of the authorization. </p><p>Example: Salesforce Enterprise License</p></td></tr><tr><td><code>externalIds</code></td><td>object</td><td><p>A reference to the <a href="../common-api-objects/externalids"><code>externalIds</code></a> object.</p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers data-full-width="true"><code class="lang-json">{
    "id": "ACC-1234-1234",
    "href": "/accounts/accounts/ACC-1234-1234",
    "name": "Microsoft",
    "icon": "/static/ACC-1234-1234/account.png"
}
</code></pre></td></tr><tr><td><code>eligibility</code></td><td>boolean</td><td>Indicates if authorization is enabled for the tier 1 program.</td></tr><tr><td><code>tier2</code></td><td>boolean</td><td>Indicates if authorization is enabled for the tier 2 program.</td></tr><tr><td><code>currency</code></td><td>string</td><td>The currency of the authorization.</td></tr><tr><td><code>notes</code></td><td>string</td><td>Optional notes for the authorization.</td></tr><tr><td><code>product</code></td><td>object</td><td><p>The <a href="product"><code>product</code></a> that the authorization belongs to. </p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers data-full-width="true"><code class="lang-json">{    
  "id": "PRD-1111-1111",  
  "name": "Microsoft Office 365 NCE",
  "icon": "/static/PRD-1111-1111/logo.png"
}
</code></pre></td></tr><tr><td><code>vendor</code></td><td>object</td><td><p>The vendor <a href="../accounts-api/account">account</a> to which the authorization belongs. </p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers data-full-width="true"><code class="lang-json">{
  "id": "ACC-1234-1234",  
  "name": "Microsoft",
  "icon": "/static/ACC-1234-1234/account.png"
}
</code></pre></td></tr><tr><td><code>owner</code></td><td>object</td><td><p>The SoftwareOne <a href="../accounts-api/seller"><code>seller</code></a> entity. </p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers data-full-width="true"><code class="lang-json">{
  "id": "SEL-1234-4567", 
  "name": "SoftwareOne, Inc."
}
</code></pre></td></tr><tr><td><code>statistics</code></td><td>authorizationStatistics</td><td><p>The statistics related to the authorization. </p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers data-full-width="true"><code class="lang-json">{
  "subscriptions": 5,
  "agreements": 10,
  "listings": 3,
  "sellers": 2
}
</code></pre></td></tr><tr><td><code>audit</code></td><td>object</td><td><p>A reference to the <a href="../common-api-objects/audit"><code>audit</code></a> object.</p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers data-full-width="true"><code class="lang-json">{
  "created": { 
    "at": "2023-12-14T17:28:57Z", 
    "by": { ... }
  },
  "updated": { 
    "at": "2023-12-14T17:28:57Z", 
    "by": { ... }
  }
}
</code></pre></td></tr></tbody></table>

## Example response

{% code lineNumbers="true" %}

```json
{
  "id": "AUT-1234-4678",
  "name": "Salesforce Enterprise License",
  "externalId": "WW-1001111",
  "currency": "EUR",
  "notes": "Notes about given authorization",
  "partnerProgram": true,
  "tier1": true,
  "tier2": false,
  "product": {
      "id": "PRD-1111-1111",    
      "name": "Microsoft Office 365 NCE",
      "icon": "/static/PRD-1111-1111/logo.png"
  },
  "vendor": {
    "id": "ACC-1234-1234",  
    "name": "Microsoft",
    "icon": "/static/ACC-1234-1234/account.png"
  },
  "owner": {
      "id": "SEL-1234-4567",        
      "name": "SoftwareOne, Inc."
  },
  "statistics": {
      "subscriptions" : 5,
      "agreements": 10,
      "listings": 4,
      "sellers": 1
  },
  "audit": {
    "created": { 
      "at": "2023-12-14T17:28:57Z", 
      "by": {
        "id": "UR-1234-1234-1234",
        "name": "John Smith",
        "icon": "/static/users/UR-1234-1234-1234.icon.svg"
      }
    },
    "updated": { 
      "at": "2023-12-14T17:28:57Z", 
      "by": {
        "id": "UR-1234-1234-1234",
        "name": "John Smith",
        "icon": "/static/users/UR-1234-1234-1234.icon.svg"
      }
    }
  }
}
```

{% endcode %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.platform.softwareone.com/developer-resources/rest-api/catalog-api/authorization.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.