OrgsSSO Roles

getOrgSsoRole

GET
/api/v1/orgs/{org_id}/ssoroles/{ssorole_id}

Return one organization SSO role definition, including its display name and granted privileges.

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

org_id*string
Formatuuid
ssorole_id*string
Formatuuid

Response Body

curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/ssoroles/000000ab-00ab-00ab-00ab-0000000000ab"
{  "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": [    {      "role": "admin",      "scope": "sitegroup",      "sitegroup_id": "6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9"    }  ],  "site_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1"}