Roles

/roles.get

GET https://admin-api.imid.infomaker.io/v1/roles.get

Get role by id

Query Parameters

Name	Type	Description
roleId	string	Role id

200 Successful

{
  "id": "Role id",
  "serviceId": "Service id",
  "name": "user",
  "description": "Description of speicific part xxx",
  "parentRoleId": "Role id",
  "updatedBySub": "infomaker_b8b9373b-a30d-459d-a44d-f270afb5e581"
}

400 Bad Request

"errors.api.BadRequestError"

500 Internal Server Error

"errors.api.InternalServerError"

/roles.list

GET https://admin-api.imid.infomaker.io/v1/roles.list

List roles

Path Parameters

Name	Type	Description
	string

200 Successful

[
  {
    "id": "Role id",
    "serviceId": "Service id",
    "name": "user",
    "description": "Description of speicific part xxx",
    "parentRoleId": "Role id",
    "updatedBySub": "infomaker_b8b9373b-a30d-459d-a44d-f270afb5e581"
  }
]

400 Bad Request

"errors.api.BadRequestError"

500 Internal Server Error

"errors.api.InternalServerError"

/roles.listMappedGroups

GET https://admin-api.imid.infomaker.io/v1/roles.listMappedGroups

List all mapped groups by role id

Query Parameters

Name	Type	Description
roleId	string	Role id
organizationId	string	Organization id

200 Successful

[
  {
    "roleId": "Role id",
    "unitId": "Unit id",
    "organizationId": "Organization id",
    "group": "Auth team"
  }
]

400 Bad Request

"errors.api.BadRequestError"

500 Internal Server Error

"errors.api.InternalServerError"

/roles.assignToGroup

POST https://admin-api.imid.infomaker.io/v1/roles.assignToGroup

Add group to role mapping

Request Body

Name	Type	Description
roleId	string	Role id
organizationId	string	Organization id
group	string	Organization group name
unitId	string	Unit id

200 Successful

{
  "roleId": "Role id",
  "organizationId": "Organization id",
  "group": "Auth team",
  "unitId": "Unit id"
}

400 Bad Request

"errors.api.BadRequestError"

500 Internal Server Error

"errors.api.InternalServerError"

/roles.create

POST https://admin-api.imid.infomaker.io/v1/roles.create

Create role

Request Body

Name	Type	Description
serviceId	string	Service id
name	string	Service role name
parentRoleId	string	Role id
description	string	Description of speicific part xxx

200 Successful

{
  "id": "Role id",
  "serviceId": "Service id",
  "name": "user",
  "description": "Description of speicific part xxx",
  "permissions": []
}

400 Bad Request

"errors.api.BadRequestError"

500 Internal Server Error

"errors.api.InternalServerError"

/roles.delete

POST https://admin-api.imid.infomaker.io/v1/roles.delete

Delete role by id

Request Body

Name	Type	Description
roleId	string	Role id

204 No Content

""

400 Bad Request

"errors.api.BadRequestError"

500 Internal Server Error

"errors.api.InternalServerError"

/roles.mapPermission

POST https://admin-api.imid.infomaker.io/v1/roles.mapPermission

Map permissision to role

Request Body

Name	Type	Description
roleId	string	Role id
permissionId	string	Permission id

200 Successful

{
  "roleId": "Role id",
  "permissionId": "Permission id"
}

400 Bad Request

"errors.api.BadRequestError"

500 Internal Server Error

"errors.api.InternalServerError"

/roles.setDescription

POST https://admin-api.imid.infomaker.io/v1/roles.setDescription

Set role description by id

Request Body

Name	Type	Description
roleId	string	Role id
description	string	Description of speicific part xxx

200 Successful

{
  "description": "Description of speicific part xxx"
}

400 Bad Request

"errors.api.BadRequestError"

500 Internal Server Error

"errors.api.InternalServerError"

/roles.setName

POST https://admin-api.imid.infomaker.io/v1/roles.setName

Set role name by id

Request Body

Name	Type	Description
roleId	string	Role id
name	string	Service role name

200 Successful

{
  "name": "user"
}

400 Bad Request

"errors.api.BadRequestError"

500 Internal Server Error

"errors.api.InternalServerError"

/roles.setParentRole

POST https://admin-api.imid.infomaker.io/v1/roles.setParentRole

Set role parent role by id

Request Body

Name	Type	Description
roleId	string	Role id
parentRoleId	string	Role id

200 Successful

{
  "parentRoleId": "Role id"
}

400 Bad Request

"errors.api.BadRequestError"

500 Internal Server Error

"errors.api.InternalServerError"

/roles.unassignFromGroup

POST https://admin-api.imid.infomaker.io/v1/roles.unassignFromGroup

Delete group to role mapping

Request Body

Name	Type	Description
roleId	string	Role id
organizationId	string	Organization id
group	string	Organization group name
unitId	string	Unit id

204 No Content

""

400 Bad Request

"errors.api.BadRequestError"

500 Internal Server Error

"errors.api.InternalServerError"

/roles.unmapPermission

POST https://admin-api.imid.infomaker.io/v1/roles.unmapPermission

Unmap permission from role

Request Body

Name	Type	Description
roleId	string	Role id
permissionId	string	Permission id

204 No Content

""

400 Bad Request

"errors.api.BadRequestError"

500 Internal Server Error

"errors.api.InternalServerError"