updateProfile #

Updates a profile from a tenant.

Query Syntax #

HTTP #

URL: http://kuzzle:7512/_/multi-tenancy/tenants/:group/:name/profile
Method: PUT

Other protocols #

{
  "controller": "multi-tenancy/tenant",
  "action": "updateProfile",
  "group": "{tenantGroup}",
  "name": "{tenantName}",
  "body":{
    "profileName":"{name of the profile}",
    "profileDefinition":{
        "policies":[
            {
                "roleId":"{role}"
            }
        ]
    }
  }
}

Arguments #

group: Tenant group
name: Tenant name

Body arguments #

profileName: Name of the profile
profileDefinition: Profile definition containing the policies (ie array of roles)

Response #

Returns an object containing the newly created profile

{
  "status": 200,
  "error": null,
  "action": "updateProfile",
  "controller": "multi-tenancy/tenant",
  "requestId": "<unique request identifier>",
  "result": {
    "_id": "teacher-liia-headTeacher",
    "rateLimit": 0,
    "policies": [
    {
        "roleId": "users.admin",
        "restrictedTo": [
        {
        "index": "tenant-teacher-liia"
        }
        ]
    },
    {
        "roleId": "tenants.reader"
    },
    {
        "roleId": "soft-tenants.reader",
        "restrictedTo": [
        {
        "index": "tenant-teacher-liia"
        }
        ]
    },
    {
        "roleId": "default",
        "restrictedTo": [
        {
        "index": "tenant-teacher-liia"
        }
        ]
    },
    {
        "roleId": "documents.reader",
        "restrictedTo": [
        {
        "index": "tenant-teacher-liia"
        }
        ]
    }
    ],
  "optimizedPolicies": [
    {
        "restrictedTo": {},
        "roleId": "users.admin"
    },
    {
        "roleId": "tenants.reader"
    },
    {
        "restrictedTo": {},
        "roleId": "soft-tenants.reader"
    },
    {
        "restrictedTo": {},
        "roleId": "default"
    },
    {
        "restrictedTo": {},
        "roleId": "documents.reader"
    }
    ],
 },
}