The following diagram shows the status transition process of an authorization on the platform.
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:
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 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 that the authorization belongs to.
vendor
object
(Read-only) The vendor to which the authorization belongs.
owner
object
(Read-only) Represents the SoftwareOne entity.
statistics
object
(Read-only) Shows statistics related to the authorization.
audit
object
(Read-only) Represents the object.
settings
string
(Optional) The settings value validated as JSON.
subscriptions
integer
(Read-only) Number of subscriptions assigned to the Authorization.
agreements
integer
firstInvoiceDate
datetime
First invoice data for data submitted by the vendor
frequency
string
client
boolean
Indicates direct client
partner
boolean
{
"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"
}
}
}
}(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.
The frequency at which the vendor will submit journal data.
Indicates indirect client, also called partners.
Created
Bad Request
Forbidden
Internal Server Error
No content
POST /public/v1/catalog/authorizations HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 248
{
"name": "text",
"externalIds": {
"operations": "text"
},
"currency": "text",
"notes": "text",
"product": {
"id": "text"
},
"owner": {
"id": "text"
},
"journal": {
"firstInvoiceDate": "text",
"frequency": "1m"
},
"eligibility": {
"client": true,
"partner": true
},
"settings": "text"
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"externalIds": {
"operations": "text"
},
"currency": "text",
"notes": "text",
"product": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"status": "text"
},
"vendor": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"owner": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalId": "text"
},
"statistics": {
"subscriptions": 1,
"agreements": 1,
"sellers": 1,
"listings": 1
},
"journal": {
"firstInvoiceDate": "2026-01-01T00:00:00.000Z",
"frequency": "1m"
},
"eligibility": {
"client": true,
"partner": true
},
"settings": "text"
}OK
GET /public/v1/catalog/authorizations HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
OK
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"externalIds": {
"operations": "text"
},
"currency": "text",
"notes": "text",
"product": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"status": "text"
},
"vendor": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"owner": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalId": "text"
},
"statistics": {
"subscriptions": 1,
"agreements": 1,
"sellers": 1,
"listings": 1
},
"journal": {
"firstInvoiceDate": "2026-01-01T00:00:00.000Z",
"frequency": "1m"
},
"eligibility": {
"client": true,
"partner": true
},
"settings": "text"
}
]
}OK
Bad Request
Forbidden
Not Found
PUT /public/v1/catalog/authorizations/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 202
{
"name": "text",
"externalIds": {
"operations": "text"
},
"currency": "text",
"notes": "text",
"journal": {
"firstInvoiceDate": "text",
"frequency": "1m"
},
"eligibility": {
"client": true,
"partner": true
},
"settings": "text"
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"externalIds": {
"operations": "text"
},
"currency": "text",
"notes": "text",
"product": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"status": "text"
},
"vendor": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"owner": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalId": "text"
},
"statistics": {
"subscriptions": 1,
"agreements": 1,
"sellers": 1,
"listings": 1
},
"journal": {
"firstInvoiceDate": "2026-01-01T00:00:00.000Z",
"frequency": "1m"
},
"eligibility": {
"client": true,
"partner": true
},
"settings": "text"
}No Content
No content
Forbidden
Not Found
Internal Server Error
No content
DELETE /public/v1/catalog/authorizations/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
OK
Not Found
GET /public/v1/catalog/authorizations/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"externalIds": {
"operations": "text"
},
"currency": "text",
"notes": "text",
"product": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"status": "text"
},
"vendor": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"owner": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalId": "text"
},
"statistics": {
"subscriptions": 1,
"agreements": 1,
"sellers": 1,
"listings": 1
},
"journal": {
"firstInvoiceDate": "2026-01-01T00:00:00.000Z",
"frequency": "1m"
},
"eligibility": {
"client": true,
"partner": true
},
"settings": "text"
}