Resources

"Show" always returns the currently valid snapshot of a certain entry. In case no current snapshot is available, an error is returned. Example: This happens when a resource is created with a validFrom date in the future.

The snapshots response list contains none or one element if the validAt parameter is set.

/setups

GET, POST

Parameters:

• name
• owner
• metadata.<metadata name>
• validAt
• includeSoftDeletedStates

GET list of setupIds. The parameters can be used to specify which setup IDs should be returned. The name and owner parameters can contain only one value. The metadata parameters can contain multiple values. The queries are of type AND. So if multiple parameters are specified, then only the clients matching all the specified criteria are returned.

If nothing is specified for validAt, it defaults to the current time.

To search regardless of the state validity, use validAt=any.

nevisMeta does not return soft deleted states by default. To return soft deleted states, set includeSoftDeletedStates to "true".

Examples:

name=thename returns the setup IDs that have name thename.

metadata.attr1=value1&metadata.attr2=value2&owner=admin returns the IDs of setups containing both the metadata value pairs attr1/value1 and attr2/value2, and that have admin as owner.

validAt=2020-10-14T12:00:00+02:00 returns the setups that had a valid state at the time.

includeSoftDeleteStates=true returns all setups including the soft deleted ones.

POST creates a new setup entry. The parameters are ignored.

/setups/{setupId}

DELETE, GET, PUT

Deletes/shows/updates a setup entry.

/setups/{setupId}/snapshots

GET

Parameters: validAt, includeSoftDeletedStates

List of snapshotIds.

nevisMeta does not return soft deleted states by default. To return soft deleted states, set includeSoftDeletedStates to "true".

Optional filters:

validAt=2016-05-17T11:29:25.843+02:00
includeSoftDeleteStates=true

/setups/{setupId}/snapshots/{snapshotId}

DELETE, GET

Shows a setup entry at a certain date/time.DELETE is only allowed for snapshots with a validFrom date in the future.

/setups/{setupId}/clients

GET, POST

Parameters:

• name
• owner
• scope
• metadata.<metadata name>
• validAt
• includeSoftDeletedStates

GET list of clientIds. Use the parameters to specify which client IDs should be returned. The name and owner parameters can contain only one value. The scope and metadata parameters can contain multiple values. The queries are of type AND. So if multiple parameters are specified, then only the clients matching all the specified criteria are returned.

If nothing is specified for validAt, it defaults to the current time.

To search regardless of the state validity, use validAt=any.

nevisMeta does not return soft deleted states by default. To return soft deleted states, set includeSoftDeletedStates to "true".

Examples:

scope=scope-a&scope=scope-b&owner=admin returns the IDs of clients containing both the scopes scope-a and scope-b and have admin as owner.

metadata.myattr=myvalue returns the client IDs that have a metadata info with name myattr and value myvalue.

validAt=2020-10-14T12:00:00+02:00 returns the clients that had a valid state at the time.

includeSoftDeleteStates=true returns all clients including the soft deleted ones.

POST creates a new client entry. The parameters are ignored.

/setups/{setupId}/clients/{clientId}

DELETE, GET, PUT

Deletes/shows/updates a client entry.

/setups/{setupId}/clients/{clientId}/snapshots

GET

Parameters: validAt, includeSoftDeletedStates

List of snapshotIds.

nevisMeta does not return soft deleted states by default. To return soft deleted states, set includeSoftDeletedStates to "true".

Optional filters:

validAt=2016-05-17T11:29:25.843+02:00
includeSoftDeleteStates=true

/setups/{setupId}/clients/{clientId}/snapshots/{snapshotId}

DELETE, GET

Shows a client entry at a certain date/time.

DELETE is only allowed for snapshots with a validFrom date in the future

/setups/{setupId}/resource-servers

GET, POST

Parameters:

• name
• owner
• scope
• metadata.<metadata name>
• validAt
• includeSoftDeletedStates

GET list of resourceServerIds. Use the parameters to specify which resource server IDs should be returned. The name and owner parameters can contain only one value. The scope and metadata parameters can contain multiple values. The queries are of type AND. So if multiple parameters are specified, then only the clients matching all the specified criteria are returned.

If nothing is specified for validAt, it defaults to the current time.

To search regardless of the state validity, use validAt=any.

nevisMeta does not return soft deleted states by default. To return soft deleted states, set includeSoftDeletedStates to "true".

Examples:

name=myresourceserver&owner=admin returns the IDs of resource servers containing the name myresourceserver and that have admin as owner.

metadata.key1=value1 returns the resource server IDs that have a metadata info with name key1 and value value1.

validAt=2020-10-14T12:00:00+02:00 returns the resource servers which had a valid state at the time.

includeSoftDeleteStates=true returns all resource servers including the soft deleted ones.

POST creates a new resource server entry. The parameters are ignored.

/setups/{setupId}/resource-servers/{resourceServerId}

DELETE, GET, PUT

Deletes/shows/updates a resource entry.

/setups/{setupId}/resource-servers/{resourceServerId}/ snapshots

GET

Parameters: validAt, includeSoftDeletedStates

List of snapshotIds.

nevisMeta does not return soft deleted states by default. To return soft deleted states, set includeSoftDeletedStates to "true".

Optional filters:

validAt=2016-05-17T11:29:25.843+02:00
includeSoftDeleteStates=true

/setups/{setupId}/resource-servers/{resourceId}/ snapshots/{snapshotId}

DELETE, GET

Shows a resource entry at a certain date/time.

DELETE is only allowed for snapshots with a validFrom date in the future.

setups/{setupId}/client-id-translator?oAuthClientId={oAuthClientId}

POST

Gets the entity client ID by the oauth client ID.

setups/{setupId}/tokens

DELETE, GET

Parameters: Query string keys:

• client-entity-id
• user
• page
• size

DELETE query string keys:

* user

Gets all refresh tokens belonging to a specific setup in pagination format.

When you provide a value for the client-entity-id , the result only contains refresh tokens associated with that client.

When you provide a value for the user , the result only contains refresh tokens belonging to this user ID.

By providing values for either page or size, you can control to which page you want to jump. Default value for size is 10.

DELETE refers to removing all the tokens of the user under the provided setupId. Removing a token is only allowed to admin, the owner of the client, and the user of the token. If the client does not send the user, the application will use the requesting user to delete the token.

setups/{setupId}/tokens/{tokenId}

DELETE, GET

Deletes/shows a token with provided tokenId.

setups/{setupId}/consents

GET

Parameters: Query string keys:

• client-entity-id
• user
• page
• size

Gets all persisted consents belonging to a specific setup in pagination format.

When you provide a value for the client-entity-id , the result only contains persisted consents associated with that client.

When you provide a value for the user , the result only contains persisted consents belonging to this user ID.

By providing values for either page or size, you can control to which page you want to jump. Default value of size is 10.