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

Update Organization OAuth Application By Organization ID And Application ID

Description

Updates the details and settings of an OAuth App that was created in a specified organization.

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.


string
oauthAppId Required

The unique identifier of the OAuth Application (client).


Query Parameters

Query Parameters

string
context Optional

Request Body

Request Body

CpnOrgOauthAppUpdateRequest 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",
	"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.


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 CpnOrgOauthAppResponse of type application/json
{
	"accessTokenTTL": 0,
	"allowedScopes": {
		"generalScopes": [
			"string"
		],
		"organizationScopes": {
			"roles": [
				{
					"name": "string"
				}
			]
		},
		"servicesScopes": [
			{
				"allRoles": false,
				"roles": [
					{
						"name": "string"
					}
				],
				"serviceDefinitionId": "string"
			}
		]
	},
	"createdAt": 0,
	"description": "string",
	"displayName": "string",
	"grantTypes": [
		"string"
	],
	"id": "string",
	"lastUpdatedAt": 0,
	"ownerOnlySecretRotation": false,
	"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.


integer as int64
createdAt Optional

Timestamp indicating when the organization OAuth Application was created.


string
description Optional

The description of organization OAuth Application.


string
displayName Optional

The organization OAuth Application display name.


array of string
grantTypes Optional

The OAuth grant types.


string
id Optional

The unique identifier of the OAuth Application.


integer as int64
lastUpdatedAt Optional

Timestamp indicating when the organization OAuth Application was updated.


boolean
ownerOnlySecretRotation Optional

When set to ’true’, the client is not allowed to rotate its own secret.By default, client is enabled to self-rotate its secret


integer as int32
secretRotationExpirationInSeconds Optional

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

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 PATCH -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","ownerOnlySecretRotation":false,"secret":"string","secretRotationExpirationInSeconds":0}' https://{api_host}/v2/orgs/{orgId}/oauth-apps/{oauthAppId}


Feedback

Was this page helpful?