Skip to content
OpenBot

organization.updateMember

PATCH
/v1/organization/members/{userId}
curl --request PATCH \
  --url https://example.com/v1/organization/members/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "status": "active", "roles": [ "super_administrator" ], "policies": [ { "effect": "allow", "permissionGroups": [ "responses.run" ], "resources": [ "example" ] } ] }'

Changes the status, roles or extra policies of a member. A suspended member cannot sign in, and their tokens stop working.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
userId
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
status
string
Allowed values: active suspended
roles
Array
>= 1 items
policies
Array<object>
<= 50 items
object
effect
required
string
Allowed values: allow deny
permissionGroups
required
Array<string>
>= 1 items
Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read
resources
required
Array<string>
>= 1 items

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
userId
required
string
email
required
Any of:
string
name
required
Any of:
string
status
required
string
Allowed values: active suspended
roles
required
Array
>= 1 items
policies
required
Array<object>
<= 50 items
object
effect
required
string
Allowed values: allow deny
permissionGroups
required
Array<string>
>= 1 items
Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read
resources
required
Array<string>
>= 1 items
joinedAt
required
string

Example 

{
  "status": "active",
  "roles": [
    "super_administrator"
  ],
  "policies": [
    {
      "effect": "allow",
      "permissionGroups": [
        "responses.run"
      ]
    }
  ]
}

400

Section titled “400”

PolicyInvalid | OrganizationRequired

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: PolicyInvalid
message
required
string

Example 

{
  "_tag": "PolicyInvalid"
}

401

Section titled “401”

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: PermissionDenied
permission
required
string
Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read
resource
required
string

Example 

{
  "_tag": "PermissionDenied",
  "permission": "responses.run"
}

404

Section titled “404”

MemberNotFound

Media typeapplication/json
object
_tag
required
string
Allowed values: MemberNotFound
userId
required
string

Example 

{
  "_tag": "MemberNotFound"
}

409

Section titled “409”

LastSuperAdministrator

Media typeapplication/json
object
_tag
required
string
Allowed values: LastSuperAdministrator

Example 

{
  "_tag": "LastSuperAdministrator"
}

503

Section titled “503”

OrganizationStorageUnavailable | AuthorizationUnavailable | AuthenticationUnavailable

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: OrganizationStorageUnavailable

Example 

{
  "_tag": "OrganizationStorageUnavailable"
}