Sofar logo
Sofar logo
Api
Delete a member relation DELETECollect member relations (replaced by POST /v1/role/{roleId}/member/query) GETCollect member relations POSTCreate or update a member relation PUTUpdate an existing member relation PUT
Member
PUT
/v1/role/{roleId}/member

Authorization

Collect member relations POST

Get all (or some of) the member relations which start from a role where the user has (either directly or indirectly) userManagement rights, and get those member relations involding the user itself.

Update an existing member relation PUT

A user can only execute this action if he is a member of an authorizing role which satisfies one of the following conditions: <ul> <li> The authorizing role has *direct or indirect* userManagement rights for the role to which a member is updated </li> <li> The authorizing role has *indirect* roleManagement rights for the role to which a member is updated </li> </ul>

accessBearerAuth
AuthorizationBearer <token>

In the value field below, fill in the access token. It has a 10 minutes validity period. A valid token can be obtained via the /accesstoken endpoint (call), AFTER authorization with refreshBearerAuth and the refresh token.

In: header

Path Parameters

roleId*integer

Id of the role of the newly created (or updated) member relation

Range0 <= value

Query Parameters

userEmail*string

Email of the user of the newly created (or updated) member relation

origin?string

Name of the mailbot configuration used to send an email in the case that new user credentials are created

language?string
Value in"aa" | "ab" | "af" | "ak" | "am" | "ar" | "an" | "as" | "av" | "ae" | "ay" | "az" | "ba" | "bm" | "be" | "bn" | "bi" | "bo" | "bs" | "br" | "bg" | "ca" | "cs" | "ch" | "ce" | "cu" | "cv" | "kw" | "co" | "cr" | "cy" | "da" | "de" | "dv" | "dz" | "el" | "en" | "eo" | "et" | "eu" | "ee" | "fo" | "fa" | "fj" | "fi" | "fr" | "fy" | "ff" | "gd" | "ga" | "gl" | "gv" | "gn" | "gu" | "ht" | "ha" | "sh" | "he" | "hz" | "hi" | "ho" | "hr" | "hu" | "hy" | "ig" | "io" | "ii" | "iu" | "ie" | "ia" | "id" | "ik" | "is" | "it" | "jv" | "ja" | "kl" | "kn" | "ks" | "ka" | "kr" | "kk" | "km" | "ki" | "rw" | "ky" | "kv" | "kg" | "ko" | "kj" | "ku" | "lo" | "la" | "lv" | "li" | "ln" | "lt" | "lb" | "lu" | "lg" | "mh" | "ml" | "mr" | "mk" | "mg" | "mt" | "mn" | "mi" | "ms" | "my" | "na" | "nv" | "nr" | "nd" | "ng" | "ne" | "nl" | "nn" | "nb" | "no" | "ny" | "oc" | "oj" | "or" | "om" | "os" | "pa" | "pi" | "pl" | "pt" | "ps" | "qu" | "rm" | "ro" | "rn" | "ru" | "sg" | "sa" | "si" | "sk" | "sl" | "se" | "sm" | "sn" | "sd" | "so" | "st" | "es" | "sq" | "sc" | "sr" | "ss" | "su" | "sw" | "sv" | "ty" | "ta" | "tt" | "te" | "tg" | "tl" | "th" | "ti" | "to" | "tn" | "ts" | "tk" | "tr" | "tw" | "ug" | "uk" | "ur" | "uz" | "ve" | "vi" | "vo" | "wa" | "wo" | "xh" | "yi" | "yo" | "za" | "zh" | "zu"
password?string

New user password in the case that new user is created

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PUT "https://api.eniris.be/v1/role/0/member?userEmail=string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "member": {
    "id": 0,
    "roleId": 0,
    "userEmail": "string"
  }
}
{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Missing or misformatted query parameter or body"
}
{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Failed to verify token"
}
{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "User does not have sufficient rights"
}

Create a member relation (or update the existing one) between a role and a user email A user can only execute this action if he is a member of an authorizing role which satisfies one of the following conditions: The authorizing role has direct or indirect userManagement rights for the role to which a member is added (or updated) The authorizing role has indirect roleManagement rights for the role to which a member is added (or updated)