Users
Was this helpful?
Was this helpful?
User's unique identifier, generated when the user is created.
Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$Page number to be retrieved. The number of the first page is 1.
1Number of items to be retrieved per page.
60Adds expanded resource and/or role objects to the response.
role,resourcePossible values: Flag indicating whether the total number of retrieved items should be returned.
falseExample: trueList 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.
*, all localized fields are retrieved as maps of translations, where the keys are language codes and values are the fields in their respective languages.GET /iam/{tenant}/users/{userId}/access-controls HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"id": "I981dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"roleId": "Z843dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"resourceId": "S843dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"name": {
"en": "Example name",
"de": "Beispielname"
},
"role": {
"id": "Z843dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"name": {
"en": "Example name",
"de": "Beispielname"
},
"description": {
"en": "Example role description",
"de": "Beispiel Berechtigungsbeschreibung"
},
"permissions": [
{
"id": "F243dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"applicablePermissionResources": [
"Q1233dc9e-a3f6-4573-bb01-a8ae21d2d43g"
]
},
{
"id": "F343dc9e-a3f6-4573-bb01-a8ae21d2d4ae"
}
],
"metadata": {
"version": 1,
"createdAt": "2022-01-04 10:44:51.871Z",
"modifiedAt": "2022-01-05 12:44:51.456Z"
}
},
"resource": {
"id": "S843dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"name": {
"en": "Example name",
"de": "Beispielname"
},
"description": {
"en": "Example resource description",
"de": "Beispiel Domainbeschreibung 2"
},
"code": "serviceName.resource",
"metadata": {
"version": 1,
"createdAt": "2022-01-04 10:44:51.871Z",
"modifiedAt": "2022-01-05 12:44:51.456Z"
}
},
"metadata": {
"version": 1,
"createdAt": "2019-08-24T14:15:22Z",
"modifiedAt": "2019-08-24T14:15:22Z"
}
},
{
"id": "PO43dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"roleId": "Rvsf43dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"resourceId": "L343dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"name": {
"en": "Example name 2",
"de": "Beispielname 2"
},
"role": {
"id": "Rvsf43dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"name": {
"en": "Example name 2",
"de": "Beispielname 2"
},
"description": {
"en": "Example role description 2",
"de": "Beispiel Berechtigungsbeschreibung 2"
},
"permissions": [
{
"id": "M243dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"applicablePermissionResources": [
"N943dc9e-a3f6-4573-bb01-a8ae21d2d43g"
]
},
{
"id": "Z243dc9e-a3f6-4573-bb01-a8ae21d2d4ae"
}
],
"metadata": {
"version": 1,
"createdAt": "2022-01-04 10:44:51.871Z",
"modifiedAt": "2022-01-05 12:44:51.456Z"
}
},
"resource": {
"id": "L343dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"name": {
"en": "Example name 2",
"de": "Beispielname 2"
},
"description": {
"en": "Example resource description 2",
"de": "Beispiel Domainbeschreibung 2"
},
"code": "serviceName.resource",
"metadata": {
"version": 1,
"createdAt": "2022-01-04 10:44:51.871Z",
"modifiedAt": "2022-01-05 12:44:51.456Z"
}
},
"metadata": {
"version": 1,
"createdAt": "2019-08-24T14:15:22Z",
"modifiedAt": "2019-08-24T14:15:22Z"
}
}
]Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$User's unique identifier, generated when the user is created.
Unique identifier of a resource.
Adds expanded resource and/or role objects to the response.
role,resourcePossible values: 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.
*, all localized fields are retrieved as maps of translations, where the keys are language codes and values are the fields in their respective languages.GET /iam/{tenant}/users/{userId}/access-controls/{resourceId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"id": "I981dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"roleId": "Z843dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"resourceId": "S843dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"name": {
"en": "Example name",
"de": "Beispielname"
},
"role": {
"id": "Z843dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"name": {
"en": "Example name",
"de": "Beispielname"
},
"description": {
"en": "Example role description",
"de": "Beispiel Berechtigungsbeschreibung"
},
"permissions": [
{
"id": "F243dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"applicablePermissionResources": [
"Q1233dc9e-a3f6-4573-bb01-a8ae21d2d43g"
]
},
{
"id": "F343dc9e-a3f6-4573-bb01-a8ae21d2d4ae"
}
],
"metadata": {
"version": 1,
"createdAt": "2022-01-04 10:44:51.871Z",
"modifiedAt": "2022-01-05 12:44:51.456Z"
}
},
"resource": {
"id": "S843dc9e-a3f6-4573-bb01-a8ae21d2d4ab",
"name": {
"en": "Example name",
"de": "Beispielname"
},
"description": {
"en": "Example resource description",
"de": "Beispiel Domainbeschreibung 2"
},
"code": "serviceName.resource",
"metadata": {
"version": 1,
"createdAt": "2022-01-04 10:44:51.871Z",
"modifiedAt": "2022-01-05 12:44:51.456Z"
}
},
"metadata": {
"version": 1,
"createdAt": "2019-08-24T14:15:22Z",
"modifiedAt": "2019-08-24T14:15:22Z"
}
},
{
"id": "PO43dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"roleId": "Rvsf43dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"resourceId": "S843dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"name": {
"en": "Example name 2",
"de": "Beispielname 2"
},
"role": {
"id": "Rvsf43dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"name": {
"en": "Example name 2",
"de": "Beispielname 2"
},
"description": {
"en": "Example role description 2",
"de": "Beispiel Berechtigungsbeschreibung 2"
},
"permissions": [
{
"id": "M243dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"applicablePermissionResources": [
"N943dc9e-a3f6-4573-bb01-a8ae21d2d43g"
]
},
{
"id": "Z243dc9e-a3f6-4573-bb01-a8ae21d2d4ae"
}
],
"metadata": {
"version": 1,
"createdAt": "2022-01-04 10:44:51.871Z",
"modifiedAt": "2022-01-05 12:44:51.456Z"
}
},
"resource": {
"id": "S843dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"name": {
"en": "Example name 2",
"de": "Beispielname 2"
},
"description": {
"en": "Example resource description 2",
"de": "Beispiel Domainbeschreibung 2"
},
"code": "serviceName.resource",
"metadata": {
"version": 1,
"createdAt": "2022-01-04 10:44:51.871Z",
"modifiedAt": "2022-01-05 12:44:51.456Z"
}
},
"metadata": {
"version": 1,
"createdAt": "2019-08-24T14:15:22Z",
"modifiedAt": "2019-08-24T14:15:22Z"
}
}
]Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$User's unique identifier, generated when the user is created.
Page number to be retrieved. The number of the first page is 1.
1Number of items to be retrieved per page.
60List 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}:descNote: If you want to sort the results by localized properties, the possible values are as follows:
{fieldName}.{language}{fieldName}.{language}:asc{fieldName}.{language}:descIf the sorting direction is not specified, the fields are sorted in ascending order.
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.
*, all localized fields are retrieved as maps of translations, where the keys are language codes and values are the fields in their respective languages.Flag indicating whether the total number of retrieved items should be returned.
falseExample: trueGET /iam/{tenant}/users/{userId}/groups HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"id": "Z843dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"name": {
"en": "Example name",
"de": "Beispielname"
},
"description": {
"en": "Example group description",
"de": "Beispiel Berechtigungsbeschreibung"
},
"accessControls": [
"f543dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"r243dc9e-a3f6-4573-zz01-a8ae21d2d4ae"
],
"userType": "CUSTOMER",
"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]+$User's unique identifier, generated when the user is created.
Unique identifier of a group, generated when the group is created.
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.
*, all localized fields are retrieved as maps of translations, where the keys are language codes and values are the fields in their respective languages.GET /iam/{tenant}/users/{userId}/groups/{groupId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"id": "Z843dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"name": {
"en": "Example name",
"de": "Beispielname"
},
"description": {
"en": "Example group description",
"de": "Beispiel Berechtigungsbeschreibung"
},
"accessControls": [
"f543dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"r243dc9e-a3f6-4573-zz01-a8ae21d2d4ae"
],
"userType": "CUSTOMER",
"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]+$User's unique identifier, generated when the user is created.
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.
*, all localized fields are retrieved as maps of translations, where the keys are language codes and values are the fields in their respective languages.GET /iam/{tenant}/users/{userId}/permissions/{resourceId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"id": "Z843dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"name": {
"en": "Example name",
"de": "Beispielname"
},
"description": {
"en": "Example permission description",
"de": "Beispiel Berechtigungsbeschreibung"
},
"applicableResources": [
"SQ43dc9e-a3f6-4573-bb01-a8ae21d2d4ca",
"RE43dc9e-a3f6-4573-bb01-a8ae21d2d4g1"
],
"code": "read",
"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]+$User's unique identifier, generated when the user is created.
GET /iam/{tenant}/users/{userId}/scopes HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"userId": "Z843dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"scopes": "iam.group_read iam.roles_read tenant=yourtenant"
}Retrieves all access controls assigned to a requested user. You can expand the result by resolving the role and resource references.
Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$Page number to be retrieved. The number of the first page is 1.
1Number of items to be retrieved per page.
60Adds expanded resource and/or role objects to the response.
role,resourcePossible values: Flag indicating whether the total number of retrieved items should be returned.
falseExample: trueList 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.
*, all localized fields are retrieved as maps of translations, where the keys are language codes and values are the fields in their respective languages.GET /iam/{tenant}/users/me/access-controls HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"id": "I981dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"roleId": "Z843dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"resourceId": "S843dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"name": {
"en": "Example name",
"de": "Beispielname"
},
"role": {
"id": "Z843dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"name": {
"en": "Example name",
"de": "Beispielname"
},
"description": {
"en": "Example role description",
"de": "Beispiel Berechtigungsbeschreibung"
},
"permissions": [
{
"id": "F243dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"applicablePermissionResources": [
"Q1233dc9e-a3f6-4573-bb01-a8ae21d2d43g"
]
},
{
"id": "F343dc9e-a3f6-4573-bb01-a8ae21d2d4ae"
}
],
"metadata": {
"version": 1,
"createdAt": "2022-01-04 10:44:51.871Z",
"modifiedAt": "2022-01-05 12:44:51.456Z"
}
},
"resource": {
"id": "S843dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"name": {
"en": "Example name",
"de": "Beispielname"
},
"description": {
"en": "Example resource description",
"de": "Beispiel Domainbeschreibung 2"
},
"code": "serviceName.resource",
"metadata": {
"version": 1,
"createdAt": "2022-01-04 10:44:51.871Z",
"modifiedAt": "2022-01-05 12:44:51.456Z"
}
},
"metadata": {
"version": 1,
"createdAt": "2019-08-24T14:15:22Z",
"modifiedAt": "2019-08-24T14:15:22Z"
}
},
{
"id": "PO43dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"roleId": "Rvsf43dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"resourceId": "L343dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"name": {
"en": "Example name 2",
"de": "Beispielname 2"
},
"role": {
"id": "Rvsf43dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"name": {
"en": "Example name 2",
"de": "Beispielname 2"
},
"description": {
"en": "Example role description 2",
"de": "Beispiel Berechtigungsbeschreibung 2"
},
"permissions": [
{
"id": "M243dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"applicablePermissionResources": [
"N943dc9e-a3f6-4573-bb01-a8ae21d2d43g"
]
},
{
"id": "Z243dc9e-a3f6-4573-bb01-a8ae21d2d4ae"
}
],
"metadata": {
"version": 1,
"createdAt": "2022-01-04 10:44:51.871Z",
"modifiedAt": "2022-01-05 12:44:51.456Z"
}
},
"resource": {
"id": "L343dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"name": {
"en": "Example name 2",
"de": "Beispielname 2"
},
"description": {
"en": "Example resource description 2",
"de": "Beispiel Domainbeschreibung 2"
},
"code": "serviceName.resource",
"metadata": {
"version": 1,
"createdAt": "2022-01-04 10:44:51.871Z",
"modifiedAt": "2022-01-05 12:44:51.456Z"
}
},
"metadata": {
"version": 1,
"createdAt": "2019-08-24T14:15:22Z",
"modifiedAt": "2019-08-24T14:15:22Z"
}
}
]Retrieves all own scopes granted to the user sending the request. Those are calculated based on user group assignments. For each particular group all access controls are resolved to scopes based on defined role(s) and resource(s).
Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$GET /iam/{tenant}/users/me/scopes HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"userId": "Z843dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"scopes": "iam.group_read iam.roles_read tenant=yourtenant"
}