Create Org Scoped O Auth Client

Create Org Scoped O Auth Client

Creates an organization scoped OAuth2 client.

Request
URI
POST
https://sc2-10-185-6-200.eng.vmware.com//csp/gateway/am/api/orgs/{orgId}/oauth-apps
COPY
Path Parameters
string
orgId
Required

The organization ID.

Request Body
OrgOAuthAppRequest of type(s) application/json
Optional 
{
    "id": "string",
    "secret": "string",
    "displayName": "string",
    "description": "string",
    "redirectUris": [
        "string"
    ],
    "grantTypes": [
        "string"
    ],
    "accessTokenTTL": 0,
    "refreshTokenTTL": 0,
    "maxGroupsInIdToken": 0,
    "allowedScopes": {
        "allRoles": false,
        "servicesScopes": [
            {
                "allRoles": false,
                "roleNames": [
                    "string"
                ],
                "roles": [
                    {
                        "name": "string",
                        "resource": "string"
                    }
                ],
                "serviceDefinitionId": "string"
            }
        ],
        "organizationScopes": {
            "allRoles": false,
            "roleNames": [
                "string"
            ],
            "roles": [
                {
                    "name": "string"
                }
            ]
        },
        "generalScopes": [
            "string"
        ]
    }
}
string
id
Optional

The client ID. If not set one will be generated.

string
secret
Optional

The client secret. If not set one will be generated.

string
displayName
Optional

Display name for the client.

string
description
Optional

Description for the client.

array of string
redirectUris
Optional

Redirect URIs for the client. Only the first one will be taken into account by the Identity Service.

array of string
grantTypes
Optional

Client grant types.

integer As int32 As int32
accessTokenTTL
Optional

Time to live for the access token, generated for this client, in seconds. Defaults to 0 if not set, i.e. the token will be issued already expired.

integer As int32 As int32
refreshTokenTTL
Optional

Time to live for the refresh token, generated for this client, in seconds. Defaults to 0 if not set, i.e. the token will be issued already expired.

integer As int32 As int32
maxGroupsInIdToken
Optional

For CSP compatibility, ignored by the Identity Service. Note that the value will be persisted and may become effective in the future releases.

AllowedScopes
allowedScopes
Optional

allowedScopes

Responses
200

default response

Returns ClientAndSecretResponse of type(s) */* 
{
    "clientId": "string",
    "clientSecret": "string"
}
string
clientId
Optional

The client ID.

string
clientSecret
Optional

The client secret.


On This Page
Org O Auth App Controller Operations
POST
Create Org Scoped O Auth Client
DELETE
Delete Org Scoped O Auth Client