List Application Registrations by Portal
Lists all of the application registrations and their current status (e.g., approved or pending) for this portal. Each registration is associated with a single API product version. Access is provided through the credentials issued to the application that contains each registration.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Sorts a collection of application registrations. Supported sort attributes are:
- created_at
- updated_at
- developer_id
- status
Filter application registrations returned in the response.
Show Child Parameters
Path Parameters
ID of the portal.
Response
application/json
Response
A paginated list of application registrations.
ListApplicationRegistrationsResponse
returns the pagination information
Show Child Parameters
A application’s registration for a specific version of a product.
Example:{"id":"c300cc33-2d33-4754-b086-a98e0fcd36fb","status":"approved","application":{"id":"c15e2460-ba40-431d-9df0-4957fcff7cda","name":"App 1"},"product":{"id":"86f637b7-cd95-478b-9b02-d770618f641c","name":"Great Product"},"product_version":{"id":"74e54925-20a0-4788-9873-d24db33f1495","name":"v1"},"developer":{"id":"ecd9feff-b4da-4a9f-ba49-cbe83c75ff22","name":"Jane Dev"},"granted_scopes":["openid"],"created_at":"2022-12-22T20:13:07.305Z","updated_at":"2022-12-22T20:13:36.710Z"}
Show Child Parameters
Authentication
Path Parameters
Query Parameters
List Registrations by Application
Lists each API product version that this application is registered for and their current status (e.g., pending, approved, rejected, revoked).
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Sorts a set of registrations for an application. Supported sort attributes are:
- created_at
- updated_at
- status
Filter application registrations returned in the response.
Show Child Parameters
Path Parameters
ID of the portal.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Response
application/json
Response
A paginated list of application registrations.
ListApplicationRegistrationsResponse
returns the pagination information
Show Child Parameters
A application’s registration for a specific version of a product.
Example:{"id":"c300cc33-2d33-4754-b086-a98e0fcd36fb","status":"approved","application":{"id":"c15e2460-ba40-431d-9df0-4957fcff7cda","name":"App 1"},"product":{"id":"86f637b7-cd95-478b-9b02-d770618f641c","name":"Great Product"},"product_version":{"id":"74e54925-20a0-4788-9873-d24db33f1495","name":"v1"},"developer":{"id":"ecd9feff-b4da-4a9f-ba49-cbe83c75ff22","name":"Jane Dev"},"granted_scopes":["openid"],"created_at":"2022-12-22T20:13:07.305Z","updated_at":"2022-12-22T20:13:36.710Z"}
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Get Application Registration
Returns information about an application’s registration status for a particular API product version.
Path Parameters
ID of the portal.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Response
application/json
Response
Details about an application registration.
GetApplicationRegistrationResponse
A application’s registration for a specific version of a product.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
The status of an application registration request. Each registration is linked to a single version of a product, and application credentials will not grant access to the product version until the registration is approved.
Pending, revoked, and rejected registrations will not provide access to the product version.
Allowed values:approvedpendingrevokedrejected
Example:approved
Details about the product the application is registered to.
Show Child Parameters
Details about the version of the product the application is registered to.
Show Child Parameters
Details about the application the registration is part of.
Show Child Parameters
Details about the developer that owns the application the registration is part of.
Show Child Parameters
Cached list of granted scopes for the registration. Identical for all registrations of an applications, use /portals/{portalId}/applications/{applicationId} to get up to date granted scopes from the IDP. Null if application type does not support returning granted scopes.
Authentication
Path Parameters
Update Application Registration
Updates the status of a particular application registration to an API Product Version. Approved application registrations will allow API traffic to the corresponding API. Revoked, rejected, or pending will not allow API traffic.
Path Parameters
ID of the portal.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Body
application/json
Body
Update an application registration.
UpdateApplicationRegistrationRequest
The status of an application registration request. Each registration is linked to a single version of a product, and application credentials will not grant access to the product version until the registration is approved.
Pending, revoked, and rejected registrations will not provide access to the product version.
Allowed values:approvedpendingrevokedrejected
Example:approved
Response
application/json
Response
Details about the application registration being updated.
UpdateApplicationRegistrationResponse
A application’s registration for a specific version of a product.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
The status of an application registration request. Each registration is linked to a single version of a product, and application credentials will not grant access to the product version until the registration is approved.
Pending, revoked, and rejected registrations will not provide access to the product version.
Allowed values:approvedpendingrevokedrejected
Example:approved
Details about the product the application is registered to.
Show Child Parameters
Details about the version of the product the application is registered to.
Show Child Parameters
Details about the application the registration is part of.
Show Child Parameters
Details about the developer that owns the application the registration is part of.
Show Child Parameters
Cached list of granted scopes for the registration. Identical for all registrations of an applications, use /portals/{portalId}/applications/{applicationId} to get up to date granted scopes from the IDP. Null if application type does not support returning granted scopes.
Authentication
Path Parameters
Body
Delete Application Registration
Deletes an application registration, which if currently approved will immediately block API traffic to the API product version.
Note: Developers can request a new application registration for the given API product version as long as they have RBAC access to consume.
Path Parameters
ID of the portal.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Response
Response
No Content