List Registrations for App

Lists API registrations for an application.

get
/api/v3/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[api_name][eq]string

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

Example:good service

filter[api_name]string

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

Example:good service

filter[api_name][contains]string

Filter by contains comparison of the api_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.

ListApiRegistrationsResponse

* 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 App for API

Registers an application for an API.

post
/api/v3/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.
api_idstring(uuid)required

The API id required for registration.

Response

application/json

Registration creation response.

GetApiRegistrationResponse

* 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

api_namestringrequired

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

api_idstring(uuid)required

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

api_slugstringrequired

The API slug is used in generated URLs to provide human readable paths.

Defaults to slugify(name + version)

Example:my-api-v1

application_idstring(uuid)required

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

application/json

Get an App Registration

Retrieves the specified API registration for an application.

get
/api/v3/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.

GetApiRegistrationResponse

* 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

api_namestringrequired

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

api_idstring(uuid)required

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

api_slugstringrequired

The API slug is used in generated URLs to provide human readable paths.

Defaults to slugify(name + version)

Example:my-api-v1

application_idstring(uuid)required

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

application/json

Delete App Registration

Unregister an application for an API.

delete
/api/v3/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.

CreateRegistrationPayload

object

The payload to create a registration.

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

The API id required for registration.

Example