Resources
Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$
Number of items to be retrieved per page.
60
Page number to be retrieved. The number of the first page is 1.
1
List of properties used to sort the results, separated by colons. The order of properties indicates their priority in sorting.
Possible values:
{fieldName}
{fieldName}:asc
{fieldName}:desc
Note: If you want to sort the results by localized properties, the possible values are as follows:
{fieldName}.{language}
{fieldName}.{language}:asc
{fieldName}.{language}:desc
If the sorting direction is not specified, the fields are sorted in ascending order.
Search by the name of a given resource. The value will be conformed against all of the specified accepted languages.
Search by the description of the the given resource, it will be conformed against all of the specified accepted-languages.
Search by given resources that contain the metadata.modifiedAt
date field with a date later than the specified value. The format is as follows: ''yyyy-MM-dd''.
2022-01-01
List of language codes acceptable for the response. You can specify factors that indicate which language should be retrieved if the one with a higher factor was not found in the localized fields. If the value is specified, then it must be present in the tenant configuration.
- If the header is set to a particular language or a list of languages, all localized fields are retrieved as strings.
- If the header is set to
*
, all localized fields are retrieved as maps of translations, where the keys are language codes and values are the fields in their respective languages. - If the header is empty, localized fields are retrieved in the default language defined in the Configuration Service.
Flag indicating whether the total number of retrieved items should be returned.
false
Example: true
The request was successful. A list of resources is returned.
Request was syntactically incorrect. Details will be provided in the response payload
Given request is unauthorized - the authorization token is invalid or has expired. It usually means that tenant from the token does not match tenant from path.
Scope validation failed, details will be provided in response message
GET /iam/{tenant}/resources HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"id": "Z843dc9e-a3f6-4573-bb01-a8ae21d2d4af",
"name": {
"en": "Example name",
"de": "Beispielname"
},
"description": {
"en": "Example resource description",
"de": "Beispiel Berechtigungsbeschreibung"
},
"code": "serviceName.resource",
"metadata": {
"version": 1,
"createdAt": "2022-01-04 10:44:51.871Z",
"modifiedAt": "2022-01-05 12:44:51.456Z"
}
}
]
Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$
Unique identifier of a resource.
List of language codes acceptable for the response. You can specify factors that indicate which language should be retrieved if the one with a higher factor was not found in the localized fields. If the value is specified, then it must be present in the tenant configuration.
- If the header is set to a particular language or a list of languages, all localized fields are retrieved as strings.
- If the header is set to
*
, all localized fields are retrieved as maps of translations, where the keys are language codes and values are the fields in their respective languages. - If the header is empty, localized fields are retrieved in the default language defined in the Configuration Service.
The request was successful. Resource details are returned.
Unsupported language provided.
Given request is unauthorized - the authorization token is invalid or has expired. It usually means that tenant from the token does not match tenant from path.
Scope validation failed, details will be provided in response message
Given resources cannot be found.
GET /iam/{tenant}/resources/{resourceId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"id": "Z843dc9e-a3f6-4573-bb01-a8ae21d2d4af",
"name": {
"en": "Example name",
"de": "Beispielname"
},
"description": {
"en": "Example resource description",
"de": "Beispiel Berechtigungsbeschreibung"
},
"code": "serviceName.resource",
"metadata": {
"version": 1,
"createdAt": "2022-01-04 10:44:51.871Z",
"modifiedAt": "2022-01-05 12:44:51.456Z"
}
}
Was this helpful?