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
Constraints: minimum: 0 default: 0
Specifies the index that the set of results will begin with
integer
pageLimit
Optional
Constraints: minimum: 1 maximum: 15 default: 15
Specifies the maximum results per page for every call.
string
searchTerm
Optional
Constraints: minLength: 0 maxLength: 256
A search term to be used to filter OAuth apps by either display name or client id.
Responses
200
OK
Returns PagedResponseOrgOAuthAppResponse of type(s) application/json
{
"prevLink": "/csp/serviceName/ResourceName?pageStart=30&pageLimit=15",
"results": [
{
"allowedActorsAudienceExchange": [
"string"
],
"crossOrgAccessClaimsSupported": false,
"organizationId": "string",
"description": "string",
"maxAdditionalAttributesInIdToken": 0,
"lastUsedAt": 0,
"secretAge": 0,
"grantTypes": [
"string"
],
"secretRotationExpirationInSeconds": 0,
"displayName": "string",
"id": "string",
"redirectUris": [
"string"
],
"allowOpenRedirectUris": false,
"immutable": false,
"lastUpdatedBy": "string",
"isHidden": false,
"allowedScopes": {
"organizationScopes": {
"keptInToken": [
"string"
],
"allRoles": false,
"permissions": [
{
"resources": [
"string"
],
"permissionId": "string"
}
],
"allPermissions": false,
"roles": [
{
"name": "string",
"resource": "string"
}
]
},
"servicesScopes": [
{
"keptInToken": [
"string"
],
"allRoles": false,
"permissions": [
{
"resources": [
"string"
],
"permissionId": "string"
}
],
"serviceDefinitionId": "string",
"roles": [
{
"name": "string",
"resource": "string"
}
],
"allPermissions": false
}
],
"generalScopes": [
"string"
]
},
"maxGroupsInIdToken": 0,
"lastUpdatedAt": 0,
"createdAt": 0,
"allowedOrgs": [
{
"displayName": "string",
"id": "string",
"name": "string"
}
],
"accessTokenTTL": 0,
"ownerOnlySecretRotation": false,
"serviceDefinitionId": "string",
"publicClient": false,
"createdBy": "string",
"forcePkce": false,
"groupDomainAppendedInIDToken": false,
"postLogoutRedirectUris": [
"string"
],
"useCspIssuerUrl": false,
"maxCharactersInAccessToken": 0,
"additionalAttributeMasks": [
"string"
],
"refreshTokenTTL": 0,
"allowedActorsClientDelegate": [
"string"
]
}
],
"totalResults": 2000,
"nextLink": "/csp/serviceName/ResourceName?pageStart=60&pageLimit=15"
}string
prevLink
Optional
Relative path to previous page if exists. Not returned for POST requests.
array of object
results
Optional
Partial list of returned results.
integer As int32 As int32
totalResults
Optional
Total number of results if available.
string
nextLink
Optional
Relative path to next page if exists. Not returned for POST requests.
401
The user is not authorized to use the API
Returns CspErrorResponse of type(s) application/json
"CspErrorResponse Object"string
cspErrorCode
Optional
cspErrorCode
string
message
Optional
message
string
errorCode
Optional
errorCode
string
requestId
Optional
requestId
integer As int32 As int32
moduleCode
Optional
moduleCode
integer As int32 As int32
statusCode
Optional
statusCode
403
The user is forbidden to use the API
Returns CspErrorResponse of type(s) application/json
"CspErrorResponse Object"string
cspErrorCode
Optional
cspErrorCode
string
message
Optional
message
string
errorCode
Optional
errorCode
string
requestId
Optional
requestId
integer As int32 As int32
moduleCode
Optional
moduleCode
integer As int32 As int32
statusCode
Optional
statusCode
404
The requested resource could not be found
Returns CspErrorResponse of type(s) application/json
"CspErrorResponse Object"string
cspErrorCode
Optional
cspErrorCode
string
message
Optional
message
string
errorCode
Optional
errorCode
string
requestId
Optional
requestId
integer As int32 As int32
moduleCode
Optional
moduleCode
integer As int32 As int32
statusCode
Optional
statusCode
429
The user has sent too many requests
Returns CspErrorResponse of type(s) application/json
"CspErrorResponse Object"string
cspErrorCode
Optional
cspErrorCode
string
message
Optional
message
string
errorCode
Optional
errorCode
string
requestId
Optional
requestId
integer As int32 As int32
moduleCode
Optional
moduleCode
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
"CspErrorResponse Object"string
cspErrorCode
Optional
cspErrorCode
string
message
Optional
message
string
errorCode
Optional
errorCode
string
requestId
Optional
requestId
integer As int32 As int32
moduleCode
Optional
moduleCode
integer As int32 As int32
statusCode
Optional
statusCode
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/oauth-apps
On This Page
Organization Managed Oauth Apps (clients) Operations
POST
Create Organization O Auth Application By Organization Id Using POST
DELETE
Delete Organization O Auth Application By Organization Id Using DELETE
GET
Get All Organization O Auth Applications By Orgainzation Id Using GET
POST
Set New Client Secret Via Owner Client Rotation By Organization Id And Application Id Using POST
PUT
Update Organization O Auth Application Secret By Orgnization Id And Application Id Using PUT
DELETE
Delete Old Client Secret Via Owner Client Rotation By Organization Id And O Auth App Id Using DELETE
POST
Search Organization Clients By Role Names Using POST
PATCH
Update Organization O Auth Application By Organization Id And Application Id Using PATCH
GET
Get Organization O Auth Application By Organization Id And Application Id Using GET