Jump to

• Request
• Response

Get all users

get

https://{your_site_interface}/opa-hub/api/12.2.40/users

This operation will get all users.

Request

Query Parameters

• expand: string
  Comma separated list of named resources to expand, or "all" to expand all
• fields: string
  Comma separated list of fields to be returned
• links: string
  Comma separated list of links to be returned, or "none" to omit links
• q: string
  A JSON object for filtering matching property values within the collection

There's no request body for this operation.

Security

• Authorization: apiKey
  Type: apiKey

  Description: Obtain a bearer token from https://{your_site_interface}/opa-hub/api/12.2.17/auth and use it in the Authorization header as: Bearer {token}.
• oauth2_opa: oauth2
  Type: oauth2

  Description: POST the OAuth2 Client Credentials parameters to https://{your_site_interface}/opa-hub/api/12.2.17/auth and use the access token from the response in the Authorization header.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The request was successfully completed.

Body ()

Root Schema : users

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/user"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Show Source

• Array of: object user

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/user"
    }
}

Nested Schema : user

Type: object

Show Source

• adminRoles: array adminRoles
  An array of Administrator roles for this user.
• email: string
  The user email address.
• fullName: string
  The user full name.
• lastLogin: string (date-time)
  The last login of the user.
• linkedConnection: string
  Read Only: true

  The connection which the user is linked to, if there is one, otherwise this property is not displayed.
• status: string
  Default Value: Enabled

  Allowed Values: [ "Locked", "Disabled", "Enabled" ]

  The user status.
• userName(required): string
  The user identifier.
• userType: string
  Default Value: User

  Allowed Values: [ "User", "LocalAPIClient", "APIClient" ]

  The type of user.
• workspaces(required): array workspaces
  The list of workspaces that the user has roles in.

{
    "type":"object",
    "properties":{
        "userName":{
            "type":"string",
            "description":"The user identifier."
        },
        "email":{
            "type":"string",
            "description":"The user email address."
        },
        "fullName":{
            "type":"string",
            "description":"The user full name."
        },
        "status":{
            "type":"string",
            "description":"The user status.",
            "enum":[
                "Locked",
                "Disabled",
                "Enabled"
            ],
            "default":"Enabled"
        },
        "adminRoles":{
            "type":"array",
            "description":"An array of Administrator roles for this user.",
            "items":{
                "type":"string",
                "enum":[
                    "Permissions Administrator",
                    "Connections Administrator"
                ]
            }
        },
        "workspaces":{
            "type":"array",
            "description":"The list of workspaces that the user has roles in.",
            "items":{
                "description":"A Intelligent Advisor Hub workspace",
                "$ref":"#/components/schemas/userWorkspace"
            }
        },
        "userType":{
            "type":"string",
            "description":"The type of user.",
            "enum":[
                "User",
                "LocalAPIClient",
                "APIClient"
            ],
            "default":"User"
        },
        "lastLogin":{
            "type":"string",
            "format":"date-time",
            "description":"The last login of the user."
        },
        "linkedConnection":{
            "type":"string",
            "description":"The connection which the user is linked to, if there is one, otherwise this property is not displayed.",
            "readOnly":true
        }
    },
    "additionalProperties":false,
    "required":[
        "workspaces",
        "userName"
    ]
}

Nested Schema : adminRoles

Type: array

An array of Administrator roles for this user.

Show Source

• Array of: string
  Allowed Values: [ "Permissions Administrator", "Connections Administrator" ]

{
    "type":"array",
    "description":"An array of Administrator roles for this user.",
    "items":{
        "type":"string",
        "enum":[
            "Permissions Administrator",
            "Connections Administrator"
        ]
    }
}

Nested Schema : workspaces

Type: array

The list of workspaces that the user has roles in.

Show Source

• Array of: object userWorkspace

{
    "type":"array",
    "description":"The list of workspaces that the user has roles in.",
    "items":{
        "description":"A Intelligent Advisor Hub workspace",
        "$ref":"#/components/schemas/userWorkspace"
    }
}

Nested Schema : userWorkspace

Type: object

Show Source

• name: string
  The name of the Workspace
• roles: array roles
  The list of roles that the user has in the workspace.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the Workspace"
        },
        "roles":{
            "type":"array",
            "description":"The list of roles that the user has in the workspace.",
            "items":{
                "type":"string",
                "enum":[
                    "Deploy Admin",
                    "Policy Author",
                    "Determinations API",
                    "Chat Service",
                    "Viewer"
                ]
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : roles

Type: array

The list of roles that the user has in the workspace.

Show Source

• Array of: string
  Allowed Values: [ "Deploy Admin", "Policy Author", "Determinations API", "Chat Service", "Viewer" ]

{
    "type":"array",
    "description":"The list of roles that the user has in the workspace.",
    "items":{
        "type":"string",
        "enum":[
            "Deploy Admin",
            "Policy Author",
            "Determinations API",
            "Chat Service",
            "Viewer"
        ]
    }
}

Back to Top