Register an application for a product
Registers an application for a product.
Path Parameters
Id of the targeted application
Body
application/json
Body
Create an application registration.
CreateRegistrationPayload
The payload to create a registration.
The product version id required for registration.
The requested scopes for the registration, requires developer_managed_scopes to be enabled.
Response
application/json
Response
Registration creation response.
GetRegistrationResponse
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 approval status of the registration.
Allowed values:approvedpendingrejectedrevoked
Contains a unique identifier used by the Portal API for this resource.
The name of the product. This is the name that is displayed in the developer portal.
Contains a unique identifier used by the Portal API for this resource.
The name of the product version. This is the version label that is displayed in the developer portal.
Contains a unique identifier used by the Portal API for this resource.
Cached list of scopes granted for the given application registration.
Use /api/v2/applications/{applicationId}/registrations/{registrationId}/granted-scopes to get up to date granted scopes from the IDP.
This property will be omitted if not supported by the application.
Get an application registration
Retrieves the specified product registration for an application.
Path Parameters
Id of the targeted application
Contains a unique identifier used by the Portal API for this resource.
Response
application/json
Response
Get registration response.
GetRegistrationResponse
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 approval status of the registration.
Allowed values:approvedpendingrejectedrevoked
Contains a unique identifier used by the Portal API for this resource.
The name of the product. This is the name that is displayed in the developer portal.
Contains a unique identifier used by the Portal API for this resource.
The name of the product version. This is the version label that is displayed in the developer portal.
Contains a unique identifier used by the Portal API for this resource.
Cached list of scopes granted for the given application registration.
Use /api/v2/applications/{applicationId}/registrations/{registrationId}/granted-scopes to get up to date granted scopes from the IDP.
This property will be omitted if not supported by the application.
Delete an application registration
Unregister an application for a product version.
Path Parameters
Id of the targeted application
Contains a unique identifier used by the Portal API for this resource.
Response
Response
The registration has been deleted.
Get App Registration Granted Scopes
Retrieves the granted scopes of a specified product registration directly from the IDP for an application.
Will return 409 if this feature is not supported by the application.
Path Parameters
Id of the targeted application
Contains a unique identifier used by the Portal API for this resource.
Response
application/json
Response
Get granted scopes response.
GetGrantedScopesResponse
List of granted scopes, directly updated from the IDP
CreateRegistrationPayload
objectThe payload to create a registration.
The product version id required for registration.
The requested scopes for the registration, requires developer_managed_scopes to be enabled.