Jump to

• Request
• Response

Associate Roles With This User

post

/api/v2/users/{id}/roles/

Make a POST request to this resource to add or remove a role from this user. The following fields may be modified:

• id: The Role ID to add to the user. (int, required)
• disassociate: Provide if you want to remove the role. (any value, optional)

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string

Body ()

Root Schema : RoleSerializerWithParentAccess

Type: object

Show Source

• description: string
  Title: Description

  Read Only: true
• id: integer
  Title: ID

  Read Only: true
• name: string
  Title: Name

  Read Only: true
• related: string
  Title: Related

  Read Only: true
• summary_fields: string
  Title: Summary fields

  Read Only: true
• type: string
  Title: Type

  Read Only: true
• url: string
  Title: Url

  Read Only: true

{
    "properties":{
        "description":{
            "readOnly":true,
            "title":"Description",
            "type":"string"
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "name":{
            "readOnly":true,
            "title":"Name",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Body ()

Root Schema : RoleSerializerWithParentAccess

Type: object

Show Source

• description: string
  Title: Description

  Read Only: true
• id: integer
  Title: ID

  Read Only: true
• name: string
  Title: Name

  Read Only: true
• related: string
  Title: Related

  Read Only: true
• summary_fields: string
  Title: Summary fields

  Read Only: true
• type: string
  Title: Type

  Read Only: true
• url: string
  Title: Url

  Read Only: true

{
    "properties":{
        "description":{
            "readOnly":true,
            "title":"Description",
            "type":"string"
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "name":{
            "readOnly":true,
            "title":"Name",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top