Authorizations

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.

The Authorization object contains the following attributes:

Field
Type
Description

id

string

The identifier for the authorization.

Example: AUT-1234-4678

name

string

The name of the authorization.

Example: Salesforce Enterprise License

externalIds

A reference to the ExternalID object.

Example:

{
    "id": "ACC-1234-1234",
    "href": "/accounts/accounts/ACC-1234-1234",
    "name": "Microsoft",
    "icon": "/static/ACC-1234-1234/account.png"
}

eligibility

boolean

Indicates if authorization is enabled for the tier 1 program.

tier2

boolean

Indicates if authorization is enabled for the tier 2 program.

currency

string

Authorization currency.

notes

string

Optional notes for the authorization.

product

The product that the authorization belongs to.

Example:

{    
  "id": "PRD-1111-1111",  
  "name": "Microsoft Office 365 NCE",
  "icon": "/static/PRD-1111-1111/logo.png"
}

vendor

The vendor to which the authorization belongs.

Example:

{
  "id": "ACC-1234-1234",  
  "name": "Microsoft",
  "icon": "/static/ACC-1234-1234/account.png"
}

owner

The SoftwareOne seller entity.

Example:

{
  "id": "SEL-1234-4567", 
  "name": "SoftwareOne, Inc."
}

statistics

authorizationStatistics

The statistics related to the authorization.

Example:

{
  "subscriptions": 5,
  "agreements": 10,
  "listings": 3,
  "sellers": 2
}

audit

A reference to the Audit object.

Example:

{
  "created": { 
    "at": "2023-12-14T17:28:57Z", 
    "by": { ... }
  },
  "updated": { 
    "at": "2023-12-14T17:28:57Z", 
    "by": { ... }
  }
}

Example

{
  "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"
      }
    }
  }
}

Last updated

Was this helpful?