Get Paged Service Definition Orgs Using GET
Get organizations with access to specified service.
Access Policy
Role | User Accounts | Service Accounts (Client Credentials Applications) |
---|---|---|
Service Owner | ✔️ | ✔️ |
Read-only Operator | ✔️ | ✔️ |
Request
URI
GET
https://{api_host}/csp/slc/api/v2/definitions/{serviceDefinitionId}/orgs
COPY
Path Parameters
string
serviceDefinitionId
Required
The id of the service
Query Parameters
integer
pageStart
Optional
Constraints:
default: 0
The number of the page
integer
pageLimit
Optional
Constraints:
default: 200
Max number of results per page
boolean
byInvitation
Optional
Enable to get services definition orgs by invitation
boolean
addOrgInfo
Optional
Constraints:
default: true
Enable to get org info
string
userId
Optional
Enable to get list of orgs of a user where the service is enabled
Responses
200
OK
Returns
PagedResponseServiceDefinitionOrgDto
of type(s)
application/json
{
"results": [
{
"displayName": "string",
"metadata": {
"metadata": "string"
},
"name": "string",
"parentOrgId": "string",
"orgId": "string"
}
],
"nextLink": "string",
"prevLink": "string",
"totalResults": 0
}
array of
object
results
Optional
Partial list of returned results.
string
nextLink
Optional
Relative path to next page if exists. Not returned for POST requests.
string
prevLink
Optional
Relative path to previous page if exists. Not returned for POST requests.
integer As int32
As int32
totalResults
Optional
Total number of results if available.
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/csp/slc/api/v2/definitions/{serviceDefinitionId}/orgs