Skip to content
English
Contact us
  • There are no suggestions because the search field is empty.

Update organization member roles

PATCH
/api/v1/organizations/{organizationId}/members/{userId} 

       

        

         curl
          
         --request
          
         PATCH
          
         \
        

       

       

        

          
         --url
          
         https://localhost:8080/api/v1/organizations/example/members/example
          
         \
        

       

       

        

          
         --header
          
         '
         Authorization: 
          
         '
          
         \
        

       

       

        

          
         --header
          
         '
         Content-Type: application/json
         '
          
         \
        

       

       

        

          
         --data
          
         '
         { "roles": [ "example" ] }
         '

Replace the roles assigned to an existing organization member

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
organizationId
required
string

Organization ID (integer)

userId
required
string

User ID (UUID)

Request Body

Section titled “Request Body ”

Updated roles

Media type application/json
object
roles
Array
Example generated

          

           

            {
           

          

          

           

             
            "roles"
            : [
           

          

          

           

             
            "
            example
            "
           

          

          

           

             
            ]
           

          

          

           

            }

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Member roles updated successfully

Media type application/json
object
organizationId
integer
roles
Array
userId
string
Example generated

          

           

            {
           

          

          

           

             
            "organizationId"
            : 
            1
            ,
           

          

          

           

             
            "roles"
            : [
           

          

          

           

             
            "
            example
            "
           

          

          

           

             
            ],
           

          

          

           

             
            "userId"
            : 
            "
            example
            "
           

          

          

           

            }

400

Section titled “400 ”

Invalid request

Media type application/json
object
error
string
error_description
string
Example 

          

           

            {
           

          

          

           

             
            "error"
            : 
            "
            Unauthorized
            "
            ,
           

          

          

           

             
            "error_description"
            : 
            "
            Invalid token
            "
           

          

          

           

            }

401

Section titled “401 ”

Unauthorized

Media type application/json
object
error
string
error_description
string
Example 

          

           

            {
           

          

          

           

             
            "error"
            : 
            "
            Unauthorized
            "
            ,
           

          

          

           

             
            "error_description"
            : 
            "
            Invalid token
            "
           

          

          

           

            }

403

Section titled “403 ”

Forbidden - requires Organization Owner role

Media type application/json
object
error
string
error_description
string
Example 

          

           

            {
           

          

          

           

             
            "error"
            : 
            "
            Unauthorized
            "
            ,
           

          

          

           

             
            "error_description"
            : 
            "
            Invalid token
            "
           

          

          

           

            }

404

Section titled “404 ”

Membership not found

Media type application/json
object
error
string
error_description
string
Example 

          

           

            {
           

          

          

           

             
            "error"
            : 
            "
            Unauthorized
            "
            ,
           

          

          

           

             
            "error_description"
            : 
            "
            Invalid token
            "
           

          

          

           

            }

500

Section titled “500 ”

Internal server error

Media type application/json
object
error
string
error_description
string
Example 

          

           

            {
           

          

          

           

             
            "error"
            : 
            "
            Unauthorized
            "
            ,
           

          

          

           

             
            "error_description"
            : 
            "
            Invalid token
            "
           

          

          

           

            }