List

client.Organizations.Users.List(ctx, organizationID, params) (*OrganizationUserListResponse, error)

GET/organizations/{organization_id}/users

List users in an organization

ParametersExpand Collapse

organizationID string

Organization ID or label identifier

minLength1

maxLength255

params OrganizationUserListParams

After param.Field[string]optional

Query param: Cursor for forward pagination

minLength1

maxLength255

Before param.Field[string]optional

Query param: Cursor for backward pagination

minLength1

maxLength255

Expand param.Field[[]string]optional

Query param: Fields to expand in the response. Currently supports "permissions" to include the permissions field with the caller's permissions for the resource.

const OrganizationUserListParamsExpandPermissions OrganizationUserListParamsExpand = "permissions"

Limit param.Field[int64]optional

Query param: Maximum number of users to return

minimum1

maximum100

Role param.Field[OrganizationRole]optional

Query param: Filter users by role

XClientRequestID param.Field[string]optional

Header param: Unique request identifier specified by the originating caller and passed along by proxies.

formatuuid

ReturnsExpand Collapse

type OrganizationUserListResponse struct{…}

Items []OrganizationUser

ID string

The keycard account ID

minLength1

maxLength255

CreatedAt Time

The time the entity was created in utc

formatdate-time

Role OrganizationRole

User's role in the organization

Accepts one of the following:

const OrganizationRoleOrgAdmin OrganizationRole = "org_admin"

const OrganizationRoleOrgMember OrganizationRole = "org_member"

const OrganizationRoleOrgViewer OrganizationRole = "org_viewer"

Source string

Identity provider issuer

formaturi

Status OrganizationStatus

Status of organization membership

Accepts one of the following:

const OrganizationStatusActive OrganizationStatus = "active"

const OrganizationStatusDisabled OrganizationStatus = "disabled"

UpdatedAt Time

The time the entity was mostly recently updated in utc

formatdate-time

Email stringoptional

User email address

formatemail

Permissions map[string, map[string, bool]]optional

Permissions granted to the authenticated principal for this resource. Only populated when the 'expand[]=permissions' query parameter is provided. Keys are resource types (e.g., "organizations"), values are objects mapping permission names to boolean values indicating if the permission is granted.

PageInfo PageInfoCursor

Pagination information using cursor-based pagination

HasNextPage bool

Whether there are more items after the current page

HasPrevPage bool

Whether there are more items before the current page

EndCursor stringoptional

Cursor pointing to the last item in the current page

minLength1

maxLength255

StartCursor stringoptional

Cursor pointing to the first item in the current page

minLength1

maxLength255

Permissions map[string, map[string, bool]]optional

List

package main

import (
  "context"
  "fmt"

  "github.com/keycardai/keycard-go"
)

func main() {
  client := keycard.NewClient(

  )
  users, err := client.Organizations.Users.List(
    context.TODO(),
    "x",
    keycard.OrganizationUserListParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", users.Items)
}

{
  "items": [
    {
      "id": "ab3def8hij2klm9opq5rst7uvw",
      "created_at": "2019-12-27T18:11:19.117Z",
      "role": "org_admin",
      "source": "https://example.com",
      "status": "active",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "email": "dev@stainless.com",
      "permissions": {
        "organizations": {
          "read": true,
          "update": true
        },
        "users": {
          "read": true,
          "list": true
        }
      }
    }
  ],
  "page_info": {
    "has_next_page": true,
    "has_prev_page": true,
    "end_cursor": "x",
    "start_cursor": "x"
  },
  "permissions": {
    "organizations": {
      "read": true,
      "update": true
    },
    "users": {
      "read": true,
      "list": true
    }
  }
}

Returns Examples

{
  "items": [
    {
      "id": "ab3def8hij2klm9opq5rst7uvw",
      "created_at": "2019-12-27T18:11:19.117Z",
      "role": "org_admin",
      "source": "https://example.com",
      "status": "active",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "email": "dev@stainless.com",
      "permissions": {
        "organizations": {
          "read": true,
          "update": true
        },
        "users": {
          "read": true,
          "list": true
        }
      }
    }
  ],
  "page_info": {
    "has_next_page": true,
    "has_prev_page": true,
    "end_cursor": "x",
    "start_cursor": "x"
  },
  "permissions": {
    "organizations": {
      "read": true,
      "update": true
    },
    "users": {
      "read": true,
      "list": true
    }
  }
}