Get All Organization O Auth Applications By Orgainzation Id Using GET

Get All Organization O Auth Applications By Orgainzation Id Using GET

Get all Organization Managed OAuth Apps that were created and are owned by the organization.

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Organization Admin ✔️ ✔️
Organization Owner ✔️ ✔️
Developer ✔️ ✔️
Request
URI
GET
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/oauth-apps
COPY
Path Parameters
string
orgId
Required

Unique identifier (GUID) of the organization.

Query Parameters
integer
pageStart
Optional

Specifies the index that the set of results will begin with

integer
pageLimit
Optional

Specifies the maximum results per page for every call.

string
searchTerm
Optional

A search term to be used to filter OAuth apps by either display name or client id.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PagedResponseOrgOAuthAppResponse of type(s) application/json 
{
    "nextLink": "/csp/serviceName/ResourceName?pageStart=60&pageLimit=15",
    "prevLink": "/csp/serviceName/ResourceName?pageStart=30&pageLimit=15",
    "results": [
        {
            "accessTokenTTL": 0,
            "additionalAttributeMasks": [
                "string"
            ],
            "allowOpenRedirectUris": false,
            "allowedActorsAudienceExchange": [
                "string"
            ],
            "allowedActorsClientDelegate": [
                "string"
            ],
            "allowedOrgs": [
                {
                    "displayName": "string",
                    "id": "string",
                    "name": "string"
                }
            ],
            "allowedScopes": {
                "generalScopes": [
                    "string"
                ],
                "organizationScopes": {
                    "allPermissions": false,
                    "allRoles": false,
                    "keptInToken": [
                        "string"
                    ],
                    "permissions": [
                        {
                            "permissionId": "string",
                            "resources": [
                                "string"
                            ]
                        }
                    ],
                    "roles": [
                        {
                            "name": "string",
                            "resource": "string"
                        }
                    ]
                },
                "servicesScopes": [
                    {
                        "allPermissions": false,
                        "allRoles": false,
                        "keptInToken": [
                            "string"
                        ],
                        "permissions": [
                            {
                                "permissionId": "string",
                                "resources": [
                                    "string"
                                ]
                            }
                        ],
                        "roles": [
                            {
                                "name": "string",
                                "resource": "string"
                            }
                        ],
                        "serviceDefinitionId": "string"
                    }
                ]
            },
            "createdAt": 0,
            "createdBy": "string",
            "crossOrgAccessClaimsSupported": false,
            "description": "string",
            "displayName": "string",
            "forcePkce": false,
            "grantTypes": [
                "string"
            ],
            "groupDomainAppendedInIDToken": false,
            "id": "string",
            "immutable": false,
            "isHidden": false,
            "lastUpdatedAt": 0,
            "lastUpdatedBy": "string",
            "maxAdditionalAttributesInIdToken": 0,
            "maxCharactersInAccessToken": 0,
            "maxGroupsInIdToken": 0,
            "organizationId": "string",
            "ownerOnlySecretRotation": false,
            "postLogoutRedirectUris": [
                "string"
            ],
            "publicClient": false,
            "redirectUris": [
                "string"
            ],
            "refreshTokenTTL": 0,
            "secretRotationExpirationInSeconds": 0,
            "serviceDefinitionId": "string",
            "useCspIssuerUrl": false
        }
    ],
    "totalResults": 2000
}
string
nextLink
Optional

Relative path to next page if exists. Not returned for POST requests.

string
prevLink
Optional

Relative path to previous page if exists. Not returned for POST requests.

array of OrgOAuthAppResponse
results
Optional

Partial list of returned results.

integer As int32 As int32
totalResults
Optional

Total number of results if available.


401

The user is not authorized to use the API

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


404

The requested resource could not be found

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


500

An unexpected error has occurred while processing the request

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


On This Page
Organization Managed Oauth Apps (clients) Operations
POST
Create Organization O Auth Application By Organization Id Using POST
DELETE
Delete Old Client Secret Via Owner Client Rotation By Organization Id And O Auth App Id Using DELETE
DELETE
Delete Organization O Auth Application By Organization Id Using DELETE
GET
Get All Organization O Auth Applications By Orgainzation Id Using GET
GET
Get Organization O Auth Application By Organization Id And Application Id Using GET
POST
Search Organization Clients By Role Names Using POST
POST
Set New Client Secret Via Owner Client Rotation By Organization Id And Application Id Using POST
PATCH
Update Organization O Auth Application By Organization Id And Application Id Using PATCH
PUT
Update Organization O Auth Application Secret By Orgnization Id And Application Id Using PUT