Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Rights & Roles Service

...

Anchor
addUserToTeamgetAllRolesaddUserToTeam
getAllRoles

...

Get all the available roles
Deck of Cards
idbimAddUserToTeambimGetAllRoles
Card
labelHTTP Method
 POST GET
Status of the user(Active

/

Inactive)

roles

Status of the membership(Active / Passive)

Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: <team_slug>/members roles 

URLhttps://api.bimplus.net/v2/<team_slug>/membersroles

Examplehttps://api.bimplus.net/v2/best-company/members

JSON Structure

Name

Mandatory / Optional

Type

Description

user

mandatory

object

Information of the user

user.id

mandatory

string

Id of the user

user.email

will be ignored

string

Email of the user

user.status

will be ignored

string

will be ignored

object

Roles of the user

member_status

optional

string

Card
labelDescription
 Add a specified user to a specified team.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
    "user": {
        "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6"
    },
    "roles": [
        "Member"
    ],
    "member_status": "Active"

}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 Ok

...