Get application registrations

Lists product registrations for an application.

get
/api/v2/applications/{applicationId}/registrations

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filter[id][eq]string

Filter by direct equality comparison of the id property with a supplied value.

Example:5be86298-147b-45ab-bfaf-a1bff97dce39

filter[id]string

Filter by direct equality comparison (short-hand) of the id property with a supplied value.

Example:5be86298-147b-45ab-bfaf-a1bff97dce39

filter[status][eq]string

Filter by direct equality comparison of the status property with a supplied value.

Allowed values:approvedpendingrejectedrevoked

Example:approved

filter[status]string

Filter by direct equality comparison (short-hand) of the status property with a supplied value.

Allowed values:approvedpendingrejectedrevoked

Example:approved

filter[product_name][eq]string

Filter by direct equality comparison of the product_name property with a supplied value.

Example:good service

filter[product_name]string

Filter by direct equality comparison (short-hand) of the product_name property with a supplied value.

Example:good service

filter[product_version_name][eq]string

Filter by direct equality comparison of the product_version_name property with a supplied value.

Example:good service

filter[product_version_name]string

Filter by direct equality comparison (short-hand) of the product_version_name property with a supplied value.

Example:good service

filter[product_version_name][contains]string

Filter by contains comparison of the product_version_name property with a supplied substring

Example:good service

filter[product_name][contains]string

Filter by contains comparison of the product_name property with a supplied substring

Example:good service

Path Parameters

applicationIdstring(uuid)required

Id of the targeted application

Response

application/json

Get registrations response.

ListRegistrationsResponse

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
application/json

Register an application for a product

Registers an application for a product.

post
/api/v2/applications/{applicationId}/registrations

Path Parameters

applicationIdstring(uuid)required

Id of the targeted application

Body

application/json

Create an application registration.

CreateRegistrationPayload

The payload to create a registration.

* Additional properties are NOT allowed.
product_version_idstring(uuid)required

The product version id required for registration.

scopesarray[string]

The requested scopes for the registration, requires developer_managed_scopes to be enabled.

Response

application/json

Registration creation response.

GetRegistrationResponse

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

statusstringrequired

The approval status of the registration.

Allowed values:approvedpendingrejectedrevoked

product_idstring(uuid)required

Contains a unique identifier used by the Portal API for this resource.

product_namestringrequired

The name of the product. This is the name that is displayed in the developer portal.

product_version_idstring(uuid)required

Contains a unique identifier used by the Portal API for this resource.

product_version_namestringrequired

The name of the product version. This is the version label that is displayed in the developer portal.

application_idstring(uuid)required

Contains a unique identifier used by the Portal API for this resource.

granted_scopesarray[string]DEPRECATED

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.

application/json

Get an application registration

Retrieves the specified product registration for an application.

get
/api/v2/applications/{applicationId}/registrations/{registrationId}

Path Parameters

applicationIdstring(uuid)required

Id of the targeted application

registrationIdstring(uuid)required

Contains a unique identifier used by the Portal API for this resource.

Response

application/json

Get registration response.

GetRegistrationResponse

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

statusstringrequired

The approval status of the registration.

Allowed values:approvedpendingrejectedrevoked

product_idstring(uuid)required

Contains a unique identifier used by the Portal API for this resource.

product_namestringrequired

The name of the product. This is the name that is displayed in the developer portal.

product_version_idstring(uuid)required

Contains a unique identifier used by the Portal API for this resource.

product_version_namestringrequired

The name of the product version. This is the version label that is displayed in the developer portal.

application_idstring(uuid)required

Contains a unique identifier used by the Portal API for this resource.

granted_scopesarray[string]DEPRECATED

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.

application/json

Delete an application registration

Unregister an application for a product version.

delete
/api/v2/applications/{applicationId}/registrations/{registrationId}

Path Parameters

applicationIdstring(uuid)required

Id of the targeted application

registrationIdstring(uuid)required

Contains a unique identifier used by the Portal API for this resource.

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.

get
/api/v2/applications/{applicationId}/registrations/{registrationId}/granted-scopes

Path Parameters

applicationIdstring(uuid)required

Id of the targeted application

registrationIdstring(uuid)required

Contains a unique identifier used by the Portal API for this resource.

Response

application/json

Get granted scopes response.

GetGrantedScopesResponse

* Additional properties are NOT allowed.
scopesarray[string]required

List of granted scopes, directly updated from the IDP

application/json