Grant Service Access Using POST
Grant service access to org.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Owner | ✔️ | ❌ |
| Service Owner | ✔️ | ✔️ |
| Service Enabler | ✔️ | ✔️ |
Request
URI
POST
https://{api_host}/csp/slc/api/service-access
COPY
Request Body
GrantServiceAccessRequest
of type(s)
application/json
Required
Show optional properties
{
"serviceDefinitionId": "string",
"orgId": "string"
}{
"serviceDefinitionId": "string",
"orgId": "string",
"isTosPreSigned": false,
"instanceIds": [
"string"
],
"customScope": "string",
"targetInstanceUrl": "string"
}
string
As ^[0-9a-zA-Z_-]+$
serviceDefinitionId
Required
The id of the service
string
As ^[0-9a-zA-Z_-]+$
orgId
Required
The org UUID that will gain access to the service
boolean
isTosPreSigned
Optional
If true, the redeemer of this invitation will not have to sign TOS during onboarding process.
array of
string
instanceIds
Optional
List of the instance ids to attach to the orgId
string
customScope
Optional
Custom default role to be assigned to members of the organization when redeeming the invitation. This can be used to represent custom service resources or entities (for example: service tenantId)
string
targetInstanceUrl
Optional
Target instance url to create service instance after invitation redeem.
Responses
202
ACCEPTED
Returns
IdRefLinkDto
of type(s)
application/json
"IdRefLinkDto Object"
string
id
Optional
Unique resource identifier
string
refLink
Optional
Relative link to the resource
400
Invalid request body
Returns
IdRefLinkDto
of type(s)
application/json
"IdRefLinkDto Object"
string
id
Optional
Unique resource identifier
string
refLink
Optional
Relative link to the resource
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"orgId:"string","serviceDefinitionId:"string"}' https://{api_host}/csp/slc/api/service-access