Docs HomeInfomakerNaviga

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

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

/roles.list

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

List roles

Path Parameters

Name
Type
Description

string

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

/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

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

/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

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

/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

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

/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

""

/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

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

/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

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

/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

{
  "name": "user"
}

/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

{
  "parentRoleId": "Role id"
}

/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

""

/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

""
PreviousPermissionsNextUnits

Last updated

Was this helpful?