MspsSSO Roles

createMspSsoRole

POST
/api/v1/msps/{msp_id}/ssoroles

Create an MSP SSO role definition with a display name and the MSP privileges granted when the role is matched during SSO.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

msp_id*string
Formatuuid

Request Body

application/json

Request Body

MSP SSO role definition

name*string

Display name of the MSP SSO role

privileges*array<>

Access privileges granted by this MSP SSO role

Items1 <= items

Response Body

curl -X POST "https://example.com/api/v1/msps/000000ab-00ab-00ab-00ab-0000000000ab/ssoroles" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "privileges": [      {        "role": "admin",        "scope": "msp"      }    ]  }'
{  "created_time": 0,  "id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "modified_time": 0,  "msp_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "name": "string",  "org_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "privileges": [    {      "orggroup_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",      "role": "read",      "scope": "orggroup"    }  ],  "site_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1"}