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:

Field	Type	Description
id	string, core	(Read-only) The identifier for the authorization.
name	string, core	The name of the authorization.
externalIds	object, core	A reference to the externalIds object.
eligibility	boolean, core	Indicates if authorization is enabled for the tier 1 program.
journal	object, core	Indicates if authorization is enabled for tier 2 program.
currency	string, core	The currency of the authorization.
notes	string	(Optional) Notes for the authorization.
product	object	(Read-only) The product that the authorization belongs to.
vendor	object	(Read-only) The vendor account to which the authorization belongs.
owner	object	(Read-only) Represents the SoftwareOne seller entity.
statistics	object	(Read-only) Shows statistics related to the authorization.
audit	object	(Read-only) Represents the audit object.
settings	string	(Optional) The settings value validated as JSON.

Authorization Statistics object

Field	Type	Description
subscriptions	integer	(Read-only) Number of subscriptions assigned to the Authorization.
agreements	integer	(Read-only) Number of agreements assigned to the Authorization.
listings	integer	(Read-only) Number of listings referring to the Authorization.
sellers	integer	(Read-only) Number of sellers referring to the Authorization.

Authorization Journal object

Field	Type	Description
firstInvoiceDate	datetime	First invoice data for data submitted by the vendor
frequency	string	The frequency at which the vendor will submit journal data.

Authorization Eligibility object

Field	Type	Description
client	boolean	Indicates direct client
partner	boolean	Indicates indirect client, also called partners.

Example

AUTHORIZATION OBJECT

{
  "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."
  },
  "journal": {
    "firstInvoiceDate": "2023-12-14T17:28:57Z",
    "frequency": "Monthly"
  },
  "eligibility": {
    "client": true,
    "partner": true
  },
  "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"
      }
    }
  }
}