Skip to main content
API docs by Redocly

Resource Manager (0.0.62)

Download OpenAPI specification:Download

PoC for the OpenApi for Resource Manager

Permission

listPermissionsEvaluatorResults Deprecated

Get the Permission Evaluator Result for the current Identity and Marpp for multiple resources

Authorizations:
ApplicationToken
query Parameters
resource
required
Array of strings

The Resource Id's that you want to return the associated permissions

permission
required
Array of strings

The permissions that you want to check against

Responses

Response samples

Content type
application/json
[
  • {
    }
]

listPermissions Deprecated

Get the Resource Identity permissions associated with the current identity for a resource and marpp

Authorizations:
ApplicationToken
query Parameters
resource
required
string

The Resource Id that you want to return the associated permissions

Responses

Response samples

Content type
application/json
{
  • "identity": "string",
  • "identityPermissions": [
    ],
  • "marppPermissions": [
    ],
  • "resourceID": "string"
}

identityOnMarppHasPermissionOnResource Deprecated

DEPRECATED: Please use /permissionEvaluatorResults instead

Checks if the current Identity has the listed permissions one a Marpp and Resource

Authorizations:
ApplicationToken
path Parameters
resourceId
required
string

The Resource Id that you want to return the associated permissions

query Parameters
permission
required
Array of strings

The permissions that you want to check against

Responses

Response samples

Content type
application/json
true

getPermissionsEvaluatorResult Deprecated

DEPRECATED: Please use /permissionEvaluatorResults instead

Get the Permission Evaluator Result for the current Identity on a Marpp And Resource

Authorizations:
ApplicationToken
path Parameters
resourceId
required
string

The Resource Id that you want to return the associated permissions

query Parameters
permissions
required
Array of strings

The permissions that you want to check against

Responses

Response samples

Content type
application/json
{
  • "identity": {
    },
  • "marppId": "string",
  • "missingMarppPermissions": [
    ],
  • "missingResourcePermissions": [
    ],
  • "resourceId": "string",
  • "result": true
}

Resource

createResource Deprecated

Creates a new Resource

Authorizations:
ApplicationToken
Request Body schema: application/json

Creates a resource

id
string
object
type
string (ResourceTypeEnum)
Enum: "system" "organization" "project" "marpp" "wallet" "cloud-wallet" "node" "ledger" "explorer" "identity-group" "service-account" "smart-contract-template" "smart-contract-instance" "ledger-token" "plugin" "billing-account"

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "properties": {
    },
  • "type": "system"
}

Response samples

Content type
application/json
{
  • "properties": [
    ],
  • "resourceID": "string",
  • "resourceUUID": "string",
  • "type": {
    }
}

listResourcesContainingResourceIdForResourceType Deprecated

Fetch all Resources matching a specific resource type and contains string

Authorizations:
ApplicationToken
path Parameters
type
required
string

The type of resource that you want to return

resourceId
required
string

Part or all of a resource id that you want to filter the results by

query Parameters
lookupTerm
Array of strings

Look up terms that you want to filter the resources by

lookupTermStrategy
required
string (LookupTermStrategyEnum)
Default: "OR"
Enum: "AND" "OR"

The lookup strategy that you want to use

size
integer <int> [ 5 .. 100 ]
Default: 20

The number of items to return per page

page
integer <int> >= 0
Default: 0

The page number that you want to return

sort
Array of strings
Example: sort=name,name,asc,name,desc

The sort order that you want to return. You can specify one or more comma-separated sort keys, each followed by an optional sort direction of either asc (ascending) or desc (descending).

If you want to sort in descending order, append ,desc to the sort key; otherwise, the default is to sort in ascending order. If you want to sort in ascending order, you can optionally append ,asc.

Examples of valid sort query parameters include:

  • sort=name: Sort by name in ascending order
  • sort=name,desc: Sort by name in descending order
  • sort=name,desc,created,asc: Sort by name in descending order, then by created in ascending order
  • sort=name,desc&sort=created,asc: Sort by name in descending order, then by created in ascending order

Responses

Response samples

Content type
text/json
Example
{
  • "contentType": "IdentityPage",
  • "pageContent": [
    ],
  • "pageElements": 0,
  • "pageNumber": 0,
  • "totalElements": 0,
  • "totalPages": 0
}

deleteResource Deprecated

Delete a Resource matching the resource's ID

Authorizations:
ApplicationToken
path Parameters
resourceId
required
string

The Resource Id of the resource that you want to delete

Responses

getResource Deprecated

Fetch a Resource with a matching ID

Authorizations:
ApplicationToken
path Parameters
resourceId
required
string

The ID of the resource that you want to return

Responses

Response samples

Content type
text/json
{
  • "properties": [
    ],
  • "resourceID": "string",
  • "resourceUUID": "string",
  • "type": {
    }
}

listAllResourcesByType Deprecated

Fetch all Resources matching a specific type and filters

Authorizations:
ApplicationToken
path Parameters
type
required
string

The type of resource that you want to return

query Parameters
resourceId
string

A search string for the resources that contain part of the id

project
string
organization
string

The organization that you want to filter the resources

lookupTerm
Array of strings

Look up terms that you want to filter the resources by

lookupTermStrategy
required
string (LookupTermStrategyEnum)
Default: "OR"
Enum: "AND" "OR"

The lookup strategy that you want to use

size
integer <int> [ 5 .. 100 ]
Default: 20

The number of items to return per page

page
integer <int> >= 0
Default: 0

The page number that you want to return

sort
Array of strings
Example: sort=name,name,asc,name,desc

The sort order that you want to return. You can specify one or more comma-separated sort keys, each followed by an optional sort direction of either asc (ascending) or desc (descending).

If you want to sort in descending order, append ,desc to the sort key; otherwise, the default is to sort in ascending order. If you want to sort in ascending order, you can optionally append ,asc.

Examples of valid sort query parameters include:

  • sort=name: Sort by name in ascending order
  • sort=name,desc: Sort by name in descending order
  • sort=name,desc,created,asc: Sort by name in descending order, then by created in ascending order
  • sort=name,desc&sort=created,asc: Sort by name in descending order, then by created in ascending order

Responses

Response samples

Content type
text/json
Example
{
  • "contentType": "IdentityPage",
  • "pageContent": [
    ],
  • "pageElements": 0,
  • "pageNumber": 0,
  • "totalElements": 0,
  • "totalPages": 0
}

listResourceOfType Deprecated

Fetch a Resources matching a specific type and filters

Authorizations:
ApplicationToken
path Parameters
type
required
string

The type of resource that you want to return

query Parameters
resourceId
string

A search string for the resources that contain part of the id

project
string
organization
string

The organization that you want to filter the resources

lookupTerm
Array of strings

Look up terms that you want to filter the resources by

lookupTermStrategy
required
string (LookupTermStrategyEnum)
Default: "OR"
Enum: "AND" "OR"

The lookup strategy that you want to use

size
integer <int> [ 5 .. 100 ]
Default: 20

The number of items to return per page

page
integer <int> >= 0
Default: 0

The page number that you want to return

sort
Array of strings
Example: sort=name,name,asc,name,desc

The sort order that you want to return. You can specify one or more comma-separated sort keys, each followed by an optional sort direction of either asc (ascending) or desc (descending).

If you want to sort in descending order, append ,desc to the sort key; otherwise, the default is to sort in ascending order. If you want to sort in ascending order, you can optionally append ,asc.

Examples of valid sort query parameters include:

  • sort=name: Sort by name in ascending order
  • sort=name,desc: Sort by name in descending order
  • sort=name,desc,created,asc: Sort by name in descending order, then by created in ascending order
  • sort=name,desc&sort=created,asc: Sort by name in descending order, then by created in ascending order

Responses

Response samples

Content type
text/json
Example
{
  • "contentType": "IdentityPage",
  • "pageContent": [
    ],
  • "pageElements": 0,
  • "pageNumber": 0,
  • "totalElements": 0,
  • "totalPages": 0
}

listResourcesForIdentity Deprecated

Fetch all Resources matching a specific type and Identity and filters

Authorizations:
ApplicationToken
path Parameters
type
required
string

The type of resource that you want to return

marcoId
required
string

The Marco ID linked to the resource that you want to return

query Parameters
resourceId
string

A search string for the resources that contain part of the id

project
string
organization
string

The organization that you want to filter the resources

lookupTerm
Array of strings

Look up terms that you want to filter the resources by

lookupTermStrategy
required
string (LookupTermStrategyEnum)
Default: "OR"
Enum: "AND" "OR"

The lookup strategy that you want to use

size
integer <int> [ 5 .. 100 ]
Default: 20

The number of items to return per page

page
integer <int> >= 0
Default: 0

The page number that you want to return

sort
Array of strings
Example: sort=name,name,asc,name,desc

The sort order that you want to return. You can specify one or more comma-separated sort keys, each followed by an optional sort direction of either asc (ascending) or desc (descending).

If you want to sort in descending order, append ,desc to the sort key; otherwise, the default is to sort in ascending order. If you want to sort in ascending order, you can optionally append ,asc.

Examples of valid sort query parameters include:

  • sort=name: Sort by name in ascending order
  • sort=name,desc: Sort by name in descending order
  • sort=name,desc,created,asc: Sort by name in descending order, then by created in ascending order
  • sort=name,desc&sort=created,asc: Sort by name in descending order, then by created in ascending order

Responses

Response samples

Content type
text/json
Example
{
  • "contentType": "IdentityPage",
  • "pageContent": [
    ],
  • "pageElements": 0,
  • "pageNumber": 0,
  • "totalElements": 0,
  • "totalPages": 0
}

Marpp Identity Role

listMarppIdentityRoles Deprecated

List all the Marpp Identity Roles associated with a Marpp and the current Identity

Authorizations:
ApplicationToken
query Parameters
marpp
required
string

The Marpp Id that you want to return the associated roles

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createMarppIdentityRole Deprecated

Creates a new Marpp Identity Role Relationship for a Marpp and the current Identity

Authorizations:
ApplicationToken
Request Body schema: application/json

The MarppIdentityRole that you want to create

id
integer <int64>
identity
string
marpp
string
role
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "identity": "string",
  • "marpp": "string",
  • "role": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "identity": "string",
  • "marpp": "string",
  • "role": "string"
}

listMarppRoles Deprecated

List of Marpp Identity Roles associated with an Identity

Authorizations:
ApplicationToken
path Parameters
resourceId
required
string

The Resource Id that you want to return the associated roles

Responses

Response samples

Content type
application/json
[
  • {
    }
]

setMarppRole Deprecated

Create a Marpp Identity Role relationship between a Marpp and an Identity

Authorizations:
ApplicationToken
path Parameters
resourceId
required
string

The Resource Id that you want associated a role with

Request Body schema: application/json

The MarppIdentityRole that you want to create

id
integer <int64>
identity
string
marpp
string
role
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "identity": "string",
  • "marpp": "string",
  • "role": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "identity": "string",
  • "marpp": "string",
  • "role": "string"
}

Resource Identity Role

deleteResourceIdentityRole Deprecated

Schedules the deletion of a role belonging to the given resource and identity

Authorizations:
ApplicationToken
path Parameters
resourceId
required
string

The Resource Id you want to delete the role from

marcoId
required
string

The Marco Id that you want to delete the role from

name
required
string

The name of the role that you want to delete

Responses

listResourceIdentityRoles Deprecated

Lists all the roles that are assigned to a Resource and Identity

Authorizations:
ApplicationToken
query Parameters
resource
required
string

The resource ID that you want to find all the associated roles

identity
required
string

The Marco ID that you want to find all the associated roles

size
integer <int> [ 5 .. 100 ]
Default: 20

The number of items to return per page

page
integer <int> >= 0
Default: 0

The page number that you want to return

sort
Array of strings
Example: sort=name,name,asc,name,desc

The sort order that you want to return. You can specify one or more comma-separated sort keys, each followed by an optional sort direction of either asc (ascending) or desc (descending).

If you want to sort in descending order, append ,desc to the sort key; otherwise, the default is to sort in ascending order. If you want to sort in ascending order, you can optionally append ,asc.

Examples of valid sort query parameters include:

  • sort=name: Sort by name in ascending order
  • sort=name,desc: Sort by name in descending order
  • sort=name,desc,created,asc: Sort by name in descending order, then by created in ascending order
  • sort=name,desc&sort=created,asc: Sort by name in descending order, then by created in ascending order

Responses

Response samples

Content type
text/json
Example
{
  • "contentType": "IdentityPage",
  • "pageContent": [
    ],
  • "pageElements": 0,
  • "pageNumber": 0,
  • "totalElements": 0,
  • "totalPages": 0
}

createResourceIdentityRole Deprecated

Creates a new role for a Resource and Identity

Authorizations:
ApplicationToken
Request Body schema: application/json

The Resource Identity Role that you want to create

id
integer <int64>
identity
string
resource
string
role
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "identity": "string",
  • "resource": "string",
  • "role": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "identity": "string",
  • "resource": "string",
  • "role": "string"
}

Resource Lookup Term

deleteLookupTerm Deprecated

Delete a Resource Lookup Term

Authorizations:
ApplicationToken
path Parameters
resourceId
required
string

The Resource Id that the Lookup Term is linked to

value
required
string

The value of the Lookup Term that you want to delete

Responses

createLookupTerm Deprecated

Create a Resource Lookup Term

Authorizations:
ApplicationToken
path Parameters
resourceId
required
string

The Resource Id that you want to create the Lookup Term for

Request Body schema: application/json

The Lookup Term that you want to create

id
integer <int64>
value
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "value": "string"
}

Identity

listIdentitiesOnResources Deprecated

List of Identities on given resource IDs

Authorizations:
ApplicationToken
query Parameters
resource
required
Array of strings

One or more resource IDs that you want to find all the associated Identities for

size
integer <int> [ 5 .. 100 ]
Default: 20

The number of items to return per page

page
integer <int> >= 0
Default: 0

The page number that you want to return

sort
Array of strings
Example: sort=name,name,asc,name,desc

The sort order that you want to return. You can specify one or more comma-separated sort keys, each followed by an optional sort direction of either asc (ascending) or desc (descending).

If you want to sort in descending order, append ,desc to the sort key; otherwise, the default is to sort in ascending order. If you want to sort in ascending order, you can optionally append ,asc.

Examples of valid sort query parameters include:

  • sort=name: Sort by name in ascending order
  • sort=name,desc: Sort by name in descending order
  • sort=name,desc,created,asc: Sort by name in descending order, then by created in ascending order
  • sort=name,desc&sort=created,asc: Sort by name in descending order, then by created in ascending order

Responses

Response samples

Content type
text/json
Example
{
  • "contentType": "IdentityPage",
  • "pageContent": [
    ],
  • "pageElements": 0,
  • "pageNumber": 0,
  • "totalElements": 0,
  • "totalPages": 0
}

Marpp Identity Property

listMarppIdentityProperties Deprecated

Return a list of Marpp Identity Properties

Authorizations:
ApplicationToken
query Parameters
marpp
required
string

The Marpp Id that you want to return the properties for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createMarppIdentityProperty Deprecated

Create a Marpp Identity Property

Authorizations:
ApplicationToken
Request Body schema: application/json

The MarppIdentityProperty that you want to create

id
integer <int64>
object (Identity)
marpp
string
name
string
value
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "identity": {
    },
  • "marpp": "string",
  • "name": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "identity": {
    },
  • "marpp": "string",
  • "name": "string",
  • "value": "string"
}

Role

listRoles Deprecated

List of roles with matching names and optionally filtered by role type

Authorizations:
ApplicationToken
query Parameters
names
Array of strings

The names of the roles that you want to return

roleType
string

OPTIONAL: Filter the list of results by the role type

Responses

Response samples

Content type
text/json
[
  • {
    }
]