[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator

Create Organization OAuth Application By Organization ID

Description

Creates a new OAuth App, owned by the specified organization. If Client ID and Client Secret are not provided, they will be generated automatically.

Request

Request

URL

URL


post
https://{api_host}/v2/orgs/{orgId}/oauth-apps
Copy

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.


Query Parameters

Query Parameters

string
context Optional

context can be OPERATOR, PROVIDER or TENANT


Request Body

Request Body

OrgOauthAppRequest of mimetype application/json Optional
{
	"accessTokenTTL": 0,
	"allowedScopes": {
		"generalScopes": [
			"string"
		],
		"organizationScopes": {
			"roles": [
				{
					"name": "string"
				}
			]
		},
		"servicesScopes": [
			{
				"allRoles": false,
				"roles": [
					{
						"name": "string"
					}
				],
				"serviceDefinitionId": "string"
			}
		]
	},
	"description": "string",
	"displayName": "string",
	"id": "string",
	"ownerOnlySecretRotation": false,
	"secret": "string",
	"secretRotationExpirationInSeconds": 0
}
integer as int32
accessTokenTTL Optional

The organization OAuth Application access token time to live in seconds.


allowedScopes Optional

The allowed general, organization and service scopes of access.


string
description Optional

The description of the organization OAuth Application.


string
displayName Optional

The organization OAuth Application display name.


string as ^[A-Za-z0-9-_]+$
id Optional

The unique identifier of the OAuth Application.


boolean
ownerOnlySecretRotation Optional

When set to ’true’, the client is not allowed to rotate its own secret.


string as (?=.{8,})(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.*[!@#$%^&*()_+=\[\]-{|}',./:;<>?`~]).*
secret Optional

The organization OAuth Application secret


integer as int32
secretRotationExpirationInSeconds Optional

The secret rotation expiration in seconds. The old OAuth Application secret will expire after it.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns ClientCredentials of type application/json
{
    "ClientCredentials": {
        "clientId": "...",
        "clientSecret": "..."
    },
    "clientId": "...",
    "clientSecret": "..."
}
string
clientId Optional

The unique identifier of the client.


string
clientSecret Optional

The value of the client secret.

Errors

Errors

400

Bad Request - The request is either incomplete or incorrect


401

Unauthorized - The user is not authorized to use the API


403

Forbidden - User does not have permission for this operation

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"accessTokenTTL":0,"allowedScopes":{"generalScopes":["string"],"organizationScopes":{"roles":[{"name":"string"}]},"servicesScopes":[{"allRoles":false,"roles":[{"name":"string"}],"serviceDefinitionId":"string"}]},"description":"string","displayName":"string","id":"string","ownerOnlySecretRotation":false,"secret":"string","secretRotationExpirationInSeconds":0}' https://{api_host}/v2/orgs/{orgId}/oauth-apps


Feedback

Was this page helpful?