Role

Get service provider roles

get

Retrieve roles for a service provider

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

serviceProviderIdstringRequiredPattern: [^\/#\?]+?

Query parameters

rolestringOptional

Role of the service provider

Default: userExample: admin

Responses

200Success

application/json

get

/api/service-providers/{serviceProviderId}/role

HTTPcURLJavaScriptPython

GET /api/service-providers/{serviceProviderId}/role HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "serviceProviderId": 123,
    "role": "CLIENT_MANAGER",
    "subRoles": [
      1,
      2,
      3
    ],
    "active": true
  }
]

Add or update service provider role

post

Add or update roles for a service provider

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

serviceProviderIdstringRequiredPattern: [^\/#\?]+?

Bodyobject[]

application/json

object[]Optional

Responses

200Success

application/json

post

/api/service-providers/{serviceProviderId}/role

HTTPcURLJavaScriptPython

POST /api/service-providers/{serviceProviderId}/role HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 4

[
  {}
]

200Success

[
  {
    "serviceProviderId": 123,
    "role": "CLIENT_MANAGER",
    "subRoles": [
      1,
      2,
      3
    ],
    "active": true
  }
]

Change service provider role

put

Change a role for a service provider

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

serviceProviderIdstringRequiredPattern: [^\/#\?]+?

serviceProviderRolestringRequiredPattern: [^\/#\?]+?

Body

application/json

serviceProviderIdnumberRequired

ID of the service provider

Example: 123

rolestring · enumRequired

Role type of the service provider

Default: CLIENT_MANAGERExample: CLIENT_MANAGERPossible values:

subRolesnumber[]Optional

List of sub-role IDs

Default: []Example: [1,2,3]

activebooleanOptional

Whether the role is active

Example: true

Responses

200Success

application/json

put

/api/service-providers/{serviceProviderId}/role/{serviceProviderRole}

HTTPcURLJavaScriptPython

PUT /api/service-providers/{serviceProviderId}/role/{serviceProviderRole} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "serviceProviderId": 123,
  "role": "CLIENT_MANAGER",
  "subRoles": [
    1,
    2,
    3
  ],
  "active": true
}

200Success

{
  "serviceProviderId": 123,
  "role": "CLIENT_MANAGER",
  "subRoles": [
    1,
    2,
    3
  ],
  "active": true
}

Deactivate service provider role

delete

Deactivate a role for a service provider

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

serviceProviderIdstringRequiredPattern: [^\/#\?]+?

serviceProviderRolestringRequiredPattern: [^\/#\?]+?

Responses

200Success

application/json

delete

/api/service-providers/{serviceProviderId}/role/{serviceProviderRole}

HTTPcURLJavaScriptPython

DELETE /api/service-providers/{serviceProviderId}/role/{serviceProviderRole} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "serviceProviderId": 123,
  "role": "CLIENT_MANAGER",
  "subRoles": [
    1,
    2,
    3
  ],
  "active": true
}