Create New Service
Last modified: 11 March 2025
Request
POST <REST API URL>/services?fields=stringParameter | Description |
|---|---|
fields | Optional. Returns only the specified subset of the fields for each Service. Use Fields Syntax to define the subset. |
Request Body
service
extends authorityHolder
{
"key": string,
"homeUrl": string,
"baseUrls": [string, ...],
"userUriPattern": string,
"groupUriPattern": string,
"redirectUris": [string, ...],
"untrustedRedirectUris": [untrustedRedirectURI, ...],
"applicationName": string,
"vendor": string,
"releaseDate": calendar,
"version": string,
"iconUrl": string,
"resources": [resource, ...],
"permissions": [permission, ...],
"defaultRoles": [role, ...],
"viewers": [authorityHolder, ...],
"trusted": boolean,
"consentRequired": boolean,
"secret": string,
"apiVersion": string,
"id": string /* from authorityHolder */,
"aliases": [alias, ...] /* from authorityHolder */,
"name": string /* from authorityHolder */,
"projectRoles": [projectRole, ...] /* from authorityHolder */,
"transitiveProjectRoles": [projectRole, ...] /* from authorityHolder */,
"sourcedProjectRoles": [sourcedProjectRole, ...] /* from authorityHolder */,
"organizationRoles": [organizationRole, ...] /* from authorityHolder */,
"transitiveOrganizationRoles": [organizationRole, ...] /* from authorityHolder */,
"sourcedOrganizationRoles": [sourcedOrganizationRole, ...] /* from authorityHolder */
}
Response
Response Code | Meaning |
|---|---|
200 OK | Successful request. |
400 Bad Request | At least one of the request parameters is invalid. For example, a required field in the passed JSON object is missing. For details, check the error message in the response. |
403 Forbidden | The requester has no access to the requested resource. |
404 Not Found | The requested resource was not found. |
500 Internal Server Error | Failed to process request because of the server error. For details, check the error message in the response. |
Response body
{
"key": string,
"homeUrl": string,
"baseUrls": [string, ...],
"userUriPattern": string,
"groupUriPattern": string,
"redirectUris": [string, ...],
"untrustedRedirectUris": [untrustedRedirectURI, ...],
"applicationName": string,
"vendor": string,
"releaseDate": calendar,
"version": string,
"iconUrl": string,
"resources": [resource, ...],
"permissions": [permission, ...],
"defaultRoles": [role, ...],
"viewers": [authorityHolder, ...],
"trusted": boolean,
"consentRequired": boolean,
"secret": string,
"apiVersion": string,
"id": string /* from authorityHolder */,
"aliases": [alias, ...] /* from authorityHolder */,
"name": string /* from authorityHolder */,
"projectRoles": [projectRole, ...] /* from authorityHolder */,
"transitiveProjectRoles": [projectRole, ...] /* from authorityHolder */,
"sourcedProjectRoles": [sourcedProjectRole, ...] /* from authorityHolder */,
"organizationRoles": [organizationRole, ...] /* from authorityHolder */,
"transitiveOrganizationRoles": [organizationRole, ...] /* from authorityHolder */,
"sourcedOrganizationRoles": [sourcedOrganizationRole, ...] /* from authorityHolder */
}