Groups
Was this helpful?
Was this helpful?
Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$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}/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"
],
"b2b": {
"legalEntityId": "0149b1314144a01491314z128"
},
"mixins": {},
"metadata": {
"version": 1,
"createdAt": "2022-01-04 10:44:51.871Z",
"modifiedAt": "2022-01-05 12:44:51.456Z"
}
}Deletes a specified group.
Important: If you want to delete a group that has users assigned to it, you need to set the forceDelete query parameter to true. In this case, all user group assignments will be deleted as well. The force flag requires the iam.assignment_manage scope.
iam.group_manage
iam.assignment_manage if forceDelete is usedNote: The iam.assignment_manage scope is only required if you want to delete a group that has users assigned to it.
Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$Unique identifier of a group, generated when the group is created.
If set to true and the group has users assigned to it, both the group and the group assignments will be deleted.
Important: To set this parameter to true, you must request an access token with the iam.assignment_manage scope.
If set to false or not specified and the group has users assigned to it, the endpoint will respond with the 400 error.
falseExample: falseDELETE /iam/{tenant}/groups/{groupId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$Unique identifier of a group, generated when the group is created.
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}/groups/{groupId}/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]+$Unique identifier of a group, generated when the group is created.
Page number to be retrieved. The number of the first page is 1.
1Number of items to be retrieved per page.
60Flag indicating whether the total number of retrieved items should be returned.
falseExample: trueGET /iam/{tenant}/groups/{groupId}/users HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"id": "665776bc-d548-4ec8-8e06-c01491311176",
"groupId": "1gr5e52e-6e27-4ac5-9471-2467d3fb7504",
"userId": "00u194ip48TiObqQW417",
"userType": "CUSTOMER"
},
{
"id": "665776bc-d548-4ec8-8e06-c01491311177",
"groupId": "1gr5e52e-6e27-4ac5-9471-2467d3fb7502",
"userId": "00u194ip48TiObqQW411",
"userType": "CUSTOMER"
}
]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.
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.
Search by the name of a given resource. The value will be conformed against all of the specified accepted languages.
Standard query parameter used to search for specific values.
q=id:31065d5b-b62e, where id is the field name and 31065d5b-b62e is its required value.q=name.en:T-s where name is the name of the field, en is a language code and T-s is a required value of this field. This query works only for localized fields, which are stored in a Map format where key is a language code and value is translation to particular language. + Searching for items by date property. All numer-based property queries are valid also for dates. In that case the date should be placed within double quotes: q=metadata.createdAt:(>="2021-05-18T07:27:27.455Z" AND <"2021-05-20T07:27:27.455Z") + Searching for items with non existing or empty property: q=name.en:null where name.en is a name of fields that has value null. + Searching for items with existing property: q=attributes:exists where attributes is a name of field that has non null value. + Searching for items by multiple specific values: q=id:(5c3325baa9812100098ff48f,5c3325d1a9812100098ff494) where id is name of field and strings within a bracket are it''s required value. + Searching for items by multiple fields: q=id:5c3325baa9812100098ff48f name.en:T-s where id and ''name.en'' are the names of fields. All documents that contain given values of these fields are returned. Multiple fields separated by space can be specified. Multiple values for each field can be also specified in a format presented above. + Searching for items with string fields conforming to a regex: q=name.en:~ABCD12 or q=name.en:(~AB CD) - in case of searching for strings with space, where name is the name of field and ABCD12 or AB CD is it''s querying regex.'id:in(exampleId1,exampleId2)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-01Search by the group user type. Possible values are: CUSTOMER and EMPLOYEE
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}/groups HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"id": "1gr5e52e-6e27-4ac5-9471-2467d3fb7500",
"name": {
"en": "Customers",
"de": "Kunden"
},
"description": {
"en": "Storefront users group",
"de": "Storefront-Benutzergruppe"
},
"accessControls": [
"2ac869fc-d548-4ec8-8e06-c01491314124",
"2ac869fc-d548-4ec8-8e06-c01491314143",
"2ac869fc-d548-4ec8-8e06-c01491314144"
],
"templates": [
"2ac869fc-d548-4ec8-8e06-c01491314144"
],
"code": "CUSTOMER",
"userType": "CUSTOMER",
"b2b": {
"legalEntityId": "0149b1314144a01491314z128"
},
"metadata": {
"version": 1,
"createdAt": "2022-07-06T16:05:37.673Z",
"modifiedAt": "2022-07-06T16:05:37.673Z"
}
},
{
"id": "1gr5e52e-6e27-4ac5-9471-2467d3fb7501",
"name": {
"en": "Backoffice users",
"de": "Backoffice Nutzer"
},
"description": {
"en": "Backoffice users",
"de": "Backoffice Nutzer"
},
"accessControls": [
"4ac869fc-d548-4ec8-8e06-c01491314102",
"4ac869fc-d548-4ec8-8e06-c01491314119"
],
"templates": [
"2ac869fc-d548-4ec8-8e06-c01491314144"
],
"code": "BO_USER",
"userType": "EMPLOYEE",
"b2b": {
"legalEntityId": "0149b1314144a01491314z128"
},
"metadata": {
"version": 1,
"createdAt": "2022-07-06T16:05:38.119Z",
"modifiedAt": "2022-07-06T16:05:38.119Z"
}
}
]Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$The Content-Language request HTTP header defines language(s) of the payload.
deCustom group's identifier. If not provided, it is automatically generated
Access control unique identifiers associated with this group. Required to perform the request.
The type of the group. Possible values: 'CUSTOMER', 'EMPLOYEE'. Default value 'EMPLOYEE' if not provided
EMPLOYEEExample: CUSTOMERPossible values: Template unique identifier associated with this group. Required to perform the request.
POST /iam/{tenant}/groups HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Language: de
Content-Type: application/json
Accept: */*
Content-Length: 365
{
"name": {
"en": "Example group name",
"de": "Beispielname"
},
"description": {
"en": "Example group description",
"de": "Beispiel Gruppenbeschreibung"
},
"accessControls": [
"f543dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"r243dc9e-a3f6-4573-zz01-a8ae21d2d4ae"
],
"templates": [
"2ac869fc-d548-4ec8-8e06-c01491314144"
],
"b2b": {
"legalEntityId": "0149b1314144a01491314z128"
},
"userType": "CUSTOMER"
}{
"id": "e243dc9e-a3f6-4573-bb01-a8ae21d2d4ae"
}Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$Unique identifier of a group, generated when the group is created.
The Content-Language request HTTP header defines language(s) of the payload.
deAccess control unique identifiers associated with this group. Required to perform the request.
The type of the group. Possible values: 'CUSTOMER', 'EMPLOYEE'. Default value 'EMPLOYEE' if not provided
EMPLOYEEExample: CUSTOMERPossible values: Template unique identifier associated with this group. Required to perform the request.
PUT /iam/{tenant}/groups/{groupId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Language: de
Content-Type: application/json
Accept: */*
Content-Length: 390
{
"name": {
"en": "Example group name",
"de": "Beispielname"
},
"description": {
"en": "Example group description",
"de": "Beispiel Gruppenbeschreibung"
},
"accessControls": [
"f543dc9e-a3f6-4573-bb01-a8ae21d2d4ae",
"r243dc9e-a3f6-4573-zz01-a8ae21d2d4ae"
],
"templates": [
"2ac869fc-d548-4ec8-8e06-c01491314144"
],
"b2b": {
"legalEntityId": "0149b1314144a01491314z128"
},
"userType": "CUSTOMER",
"metadata": {
"version": 1
}
}{
"id": "e243dc9e-a3f6-4573-bb01-a8ae21d2d4ae"
}