UserAccess

Users which have access to an organization

Read all organizations users

get
/organizations/{organizationId}/members

Retrieves list of all users linked to an organization. NOTE: This endpoint does not return pending invitations. Use GET /organizations/{organizationId}/invites to retrieve list of invitations.

Required scopes
This endpoint requires the following scopes:
  • : Read your organization users
  • : Read your organization users
Authorizations
OAuth2authorizationCodeRequired

This API uses OAuth 2 with the authorization code flow for browser or client credentials flow for service accounts.

Authorization URL: Token URL:

OAuth2clientCredentialsRequired

This API uses OAuth 2 with the authorization code flow for browser or client credentials flow for service accounts.

Token URL:
Path parameters
organizationIdstringRequired

Organization ID

Example: ACsUNAGQN3Lv875yyqZiLQ2s
Responses
200

OK

application/vnd.api+json
get
/organizations/{organizationId}/members
GET /organizations/{organizationId}/members HTTP/1.1
Host: accounts.apps.verygoodsecurity.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

OK

{
  "data": [
    {
      "id": "IDvafeqcnYSvHLxtqAhur7MX",
      "type": "users",
      "attributes": {
        "created_at": "2021-06-15T12:30:45.625Z",
        "id": "IDoaR2JBZdw7KzXUTNcTbp16",
        "name": "John Wick",
        "email_address": "[email protected]",
        "vaults": [
          {
            "id": "tnto1wfx2gp",
            "name": "vault",
            "role": "admin",
            "env_identifier": "LIVE"
          }
        ],
        "role": "admin",
        "permissions": [
          "read",
          "write",
          "admin"
        ],
        "sso_id": "MK2323"
      }
    }
  ]
}