Get Org Service Access Objects Using GET

Get Org Service Access Objects Using GET

Get service-organization access objects for the specified service.

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Service Owner ✔️ ✔️
Read-only Operator ✔️ ✔️
Service Enabler ✔️ ✔️
Request
URI
GET
https://{api_host}/csp/slc/api/definitions/external/{id}/org-access
COPY
Path Parameters
string
id
Required

The id of the service

Query Parameters
string of array
orgIds
Optional

List of org ids to get

boolean
paymentCommitment
Optional

Enable to get access objects with payment commitment

boolean
noCreatedSubscription
Optional

Enable to get access object without any enabled subscriptions

string
onboardingType
Optional

The type of the onboarding

string
userId
Optional

The id of the user

string
clientId
Optional

The id of the client

boolean
expandOrgs
Optional

Set true to expand organization information

integer
pageStart
Optional
Constraints: default: 0

The number of the page

integer
pageLimit
Optional

Max Amount of results per page, the defaultValue value is 200

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PagedResponseOrgServiceAccessResponse of type(s) application/json 
{
    "results": [
        {
            "orgId": "string",
            "orgName": "string",
            "orgOwners": [
                "string"
            ],
            "serviceDefinitionId": "string",
            "accessState": "string",
            "context": {
                "context": {}
            },
            "trialDetails": {
                "trialEnd": "string",
                "trialStart": "string",
                "trialEndReason": "string",
                "paymentCommitment": false,
                "seller": "string",
                "status": "string",
                "endTrialConfiguration": {
                    "postTrialConfiguration": {
                        "roles": [
                            "string"
                        ],
                        "duration": 0,
                        "notifyPostTrialEnded": false
                    },
                    "serviceEndTrialBehaviour": {
                        "endTrialBehaviourType": "string",
                        "endTrialOnPaymentConfirmation": false,
                        "subscriptionType": [
                            "string"
                        ]
                    }
                }
            },
            "createdAt": "string",
            "serviceInvitationId": "string",
            "assignedServiceUrl": "string",
            "isBundle": false,
            "hideServiceTile": false,
            "setupNeeded": false
        }
    ],
    "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/definitions/external/{id}/org-access
On This Page
Service Org Access Controller Operations
POST
Change Org Service Access Using POST
GET
Get Org Service Access Objects Using GET
GET
Get Org Service Access Objects By Access State And Trial State Using GET