Get All Organization OAuth Applications By Orgainzation ID
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 Owner | ✔️ | ✔️ |
| Developer | ✔️ | ✔️ |
Request
URLURL
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/oauth-apps
Path Parameters
Path Parameters
string
orgId
Required
Unique identifier (GUID) of the organization.
Parameter Serialization Style:simple Explode:false
Query Parameters
Query Parameters
integer
pageLimit
Optional
Specifies the maximum results per page for every call.
Parameter Serialization Style:form Explode:true
integer
pageStart
Optional
Specifies the index that the set of results will begin with
Parameter Serialization Style:form Explode:true
string
searchTerm
Optional
A search term to be used to filter OAuth apps by either display name or client id.
Parameter Serialization Style:form Explode:true
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
PagedResponseOrgOAuthAppResponse of type 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,
"allowedOrgs": [
{
"displayName": "string",
"id": "string",
"name": "string"
}
],
"allowedScopes": {
"generalScopes": [
"string"
],
"organizationScopes": {
"allPermissions": false,
"allRoles": false,
"keptInToken": [
"ROLES"
],
"permissions": [
{
"permissionId": "string",
"resources": [
"string"
]
}
],
"roles": [
{
"name": "string",
"resource": "string"
}
]
},
"servicesScopes": [
{
"allPermissions": false,
"allRoles": false,
"keptInToken": [
"ROLES"
],
"permissions": [
{
"permissionId": "string",
"resources": [
"string"
]
}
],
"roles": [
{
"name": "string",
"resource": "string"
}
],
"serviceDefinitionId": "string"
}
]
},
"createdAt": 0,
"createdBy": "string",
"description": "string",
"displayName": "string",
"forcePkce": false,
"grantTypes": [
"string"
],
"groupDomainAppendedInIDToken": false,
"id": "string",
"immutable": 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"
}
],
"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.
integer
totalResults
Optional
Total number of results if available.
Errors
Code Samples
Code Samples
cURL Command
curl https://{api_host}/csp/gateway/am/api/orgs/{orgId}/oauth-apps
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_owner,developer
x-slo-tier: TIER2
