--- title: "List users In org" method: GET path: "/v2/org/{org-name}/users" tags: ["Users Management"] --- # List users In org `GET /v2/org/{org-name}/users` Get list of users in organization. (User Admin in org privileges required) ## Path parameters - `org-name` string, required ## Query parameters - `exclude-from-team` string - `page-number` integer - `page-size` integer - `q` SearchParams - `orderBy` SearchParamOrderBy[] - `field` string - `value` 'ASC' | 'DESC' - `queryFields` string[] - `scoredSize` integer - `pageSize` integer - `fields` string[] - `page` integer - `filters` SearchParamFilter[] - `field` string - `value` string - `query` string - `groupBy` string ## Response `200` OK - UserListResponse — Response for List User reponse - `paginationInfo` PaginationInfo — object that describes the pagination information - `totalPages` integer — Total number of pages available - `index` integer — Page index of results - `totalResults` integer — Total number of results available - `nextPage` string — Serialized pointer to the next results page. Should be used for fetching next page. Can be empty - `size` integer — Number of results in page - `requestStatus` RequestStatus - `serverId` string - `statusCode` 'UNKNOWN' | 'SUCCESS' | 'UNAUTHORIZED' | 'PAYMENT_REQUIRED' | 'FORBIDDEN' | 'TIMEOUT' | 'EXISTS' | 'NOT_FOUND' | 'INTERNAL_ERROR' | 'INVALID_REQUEST' | 'INVALID_REQUEST_VERSION' | 'INVALID_REQUEST_DATA' | 'METHOD_NOT_ALLOWED' | 'CONFLICT' | 'UNPROCESSABLE_ENTITY' | 'TOO_MANY_REQUESTS' | 'INSUFFICIENT_STORAGE' | 'SERVICE_UNAVAILABLE' | 'PAYLOAD_TOO_LARGE' | 'NOT_ACCEPTABLE' | 'UNAVAILABLE_FOR_LEGAL_REASONS' | 'BAD_GATEWAY' — Describes response status reported by the server. - `statusDescription` string - `requestId` string - `users` User[] — information about the user - `hasSignedContainerPublishingEULA` boolean — indicates if user has accepted container publishing eula - `hasSignedLlmEULA` boolean — indicates if user has accepted LLM End User License Agreement. - `hasSignedBaseCommandEULA` boolean — indicates if user has accepted Base Command End User License Agreement. - `storageQuota` UserStorageQuota[] — Storage quota for this user. - `available` integer — Available space in bytes - `datasetsUsage` integer — Space used by datasets in bytes - `aceName` string — name of the ace - `workspacesCount` integer — Number of workspaces that are a part of user's used storage - `orgName` string — The org name that this user quota tied to. This is needed for analytics - `resultsetCount` integer — Number of resultsets that are a part of user's used storage - `quota` integer — Assigned quota in bytes - `storageClusterDescription` string — Description of this storage cluster - `storageClusterUuid` string — Identifier to this storage cluster - `datasetCount` integer — Number of datasets that are a part of user's used storage - `aceId` integer — id of the ace - `resultsetsUsage` integer — Space used by resultsets in bytes - `workspacesUsage` integer — Space used by workspaces in bytes - `storageClusterName` string — Name of storage cluster - `userMetadata` UserMetadata — Metadata information about the user. - `companyUrl` string — Company URL - `firstName` string — User's first name - `country` string — Country of the user - `company` string — Name of the company - `role` string — Role of the user in the company - `interest` string[] — List of development areas that user has interest - `lastName` string — User's last name - `industry` string — Industry segment - `hasSignedEgxEULA` boolean — [Deprecated] indicates if user has accepted EGX End User License Agreement. - `hasBetaAccess` boolean — Determines if the user has beta access - `id` integer — unique Id of this user. - `isDeleted` boolean — Indicates if user was deleted from the system. - `hasSignedAiFoundryPartnershipsEULA` boolean — indicates if user has accepted AI Foundry Partnerships eula - `jobPositionTitle` string — Title of user's job position. - `hasSignedEarth2EULA` boolean — indicates if user has accepted Earth-2 eula - `hasSignedNvidiaEULA` boolean — Determines if the user has signed the NVIDIA End User License Agreement. - `updatedDate` string — Updated date for this user - `firstLoginDate` string — Last time the user logged in - `email` string — Email address of the user. This should be unique. - `hasSignedBioNeMoEULA` boolean — indicates if user has accepted BioNeMo End User License Agreement. - `hasSignedBaseCommandManagerEULA` boolean — indicates if user has accepted Base Command Manager End User License Agreement. - `hasSignedPrivacyPolicy` boolean — Determines if the user has signed the Privacy Policy. - `hasSignedEULA` boolean — Determines if the user has signed the NGC End User License Agreement. - `isSAML` boolean — Determines if the user is a SAML account or not. - `lastLoginDate` string — Last time the user logged in - `createdDate` string — Created date for this user - `starfleetId` string — unique starfleet id of this user. - `hasSignedNVQCEULA` boolean — indicates if user has accepted Nvidia Quantum Cloud End User License Agreement. - `isActive` boolean — Determines if the user is active or not. - `name` string — user name - `roles` UserRole[] — List of roles that the user have - `roleTypes` string[] — DEPRECATED - List of role types that the user have - `targetSystemUserIdentifier` TargetSystemUserIdentifier — Information about the user who is attempting to run the job - `uid` integer — uid of the user on this team - `orgName` string — Org context for the job - `userId` integer — Unique ID of the user who submitted the job - `teamName` string — Team context for the job - `gid` integer — gid of the user on this team - `starfleetId` string — Starfleet ID of the user creating the job. - `orgRoles` string[] — List of org role types that the user have - `team` Team — Information about the team - `repoScanSettings` RepoScanSettings — Repo scan setting definition - `repoScanAllowOverride` boolean — Allow org admin to override the org level repo scan settings - `repoScanShowResults` boolean — Allow showing scan results to CLI or UI - `repoScanEnabled` boolean — Enable the repository scan or not. Only used in org level object - `repoScanEnableNotifications` boolean — Sends notification to end user after scanning is done - `repoScanByDefault` boolean — Allow repository scanning by default - `repoScanEnableTeamOverride` boolean — Allow override settings at team level. Only used in org level object - `name` string — team name - `infinityManagerSettings` InfinityManagerSettings — Infinity manager setting definition - `infinityManagerEnabled` boolean — Enable the infinity manager or not. Used both in org and team level object - `infinityManagerEnableTeamOverride` boolean — Allow override settings at team level. Only used in org level object - `id` integer — unique Id of this team. - `isDeleted` boolean — indicates if the team is deleted or not - `description` string — description of the team - `org` Organization — Information about the Organization - `isSecureCredentialSharingServiceEnabled` boolean — Secure Credential Sharing Service enable flag for an organization - `isInternal` boolean — Is NVIDIA internal org or not - `idpId` string — Identity Provider ID. - `usersInfo` UsersInfo — Users information. - `totalUsers` integer — Total number of users. - `pecSfdcId` string — Product end customer salesforce.com Id (external customer Id). pecSfdcId is for EMS (entitlement management service) to track external paid customer. - `id` integer — Unique Id of this team. - `nan` string — NVIDIA Cloud Account Number. - `isRegistrySSEEnabled` boolean — If a server side encryption is enabled for private registry (models, resources) - `alternateContact` AlternateContact — Org Owner Alternate Contact - `fullName` string — Full name of the alternate contact. - `email` string — Alternate contact's email. - `canAddOn` boolean — Identifies if the org can be reused. - `infinityManagerSettings` InfinityManagerSettings — Infinity manager setting definition - `infinityManagerEnabled` boolean — Enable the infinity manager or not. Used both in org and team level object - `infinityManagerEnableTeamOverride` boolean — Allow override settings at team level. Only used in org level object - `billingAccountId` string — Billing account ID. - `type` 'UNKNOWN' | 'CLOUD' | 'ENTERPRISE' | 'INDIVIDUAL' - `isProto` boolean — Indicates when the org is a proto org - `repoScanSettings` RepoScanSettings — Repo scan setting definition - `repoScanAllowOverride` boolean — Allow org admin to override the org level repo scan settings - `repoScanShowResults` boolean — Allow showing scan results to CLI or UI - `repoScanEnabled` boolean — Enable the repository scan or not. Only used in org level object - `repoScanEnableNotifications` boolean — Sends notification to end user after scanning is done - `repoScanByDefault` boolean — Allow repository scanning by default - `repoScanEnableTeamOverride` boolean — Allow override settings at team level. Only used in org level object - `description` string — Optional description of the organization. - `productEnablements` ProductEnablement[] - `type` 'NGC_ADMIN_EVAL' | 'NGC_ADMIN_NFR' | 'NGC_ADMIN_COMMERCIAL' | 'EMS_EVAL' | 'EMS_NFR' | 'EMS_COMMERCIAL' | 'NGC_ADMIN_DEVELOPER', required — Product Enablement Types - `expirationDate` string — Date on which the subscription expires. The subscription is invalid after this date. (yyyy-MM-dd) - `poDetails` PurchaseOrder[] - `pkId` string — PAK (Product Activation Key) identifier. - `entitlementId` string — Entitlement identifier. - `productName` string, required — Product Name (NVAIE, BASE_COMMAND, REGISTRY, etc) - `name` string — Organization name. - `orgOwner` OrgOwner — Org owner. - `fullName` string, required — Org owner name. - `email` string, required — Email address of the org owner. - `lastLoginDate` string — Last time the org owner logged in. - `displayName` string — Name of the organization that will be shown to users. - `productSubscriptions` ProductSubscription[] - `startDate` string — Date on which the subscription becomes active. (yyyy-MM-dd) - `productName` string, required — Product Name (NVAIE, BASE_COMMAND, FleetCommand, REGISTRY, etc). - `emsEntitlementType` 'EMS_EVAL' | 'EMS_NFR' | 'EMS_COMMERICAL' | 'EMS_COMMERCIAL' — EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL) - `expirationDate` string — Date on which the subscription expires. The subscription is invalid after this date. (yyyy-MM-dd) - `type` 'NGC_ADMIN_EVAL' | 'NGC_ADMIN_NFR' | 'NGC_ADMIN_COMMERCIAL' — Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR, NGC_ADMIN_COMMERCIAL) - `id` string — Unique entitlement identifier - `country` string — ISO country code of the organization. - `industry` string — Industry of the organization. - `isSeparateInfluxDbUsed` boolean — If a separate influx db used for an organization in BCP for job telemetry - `isDatasetServiceEnabled` boolean — Dataset Service enable flag for an organization - `isSecretsManagerServiceEnabled` boolean — Secrets Manager Service enable flag for an organization - `isQuickStartEnabled` boolean — Quick Start enable flag for an organization - `orgOwners` OrgOwner[] — Org owners - `fullName` string, required — Org owner name. - `email` string, required — Email address of the org owner. - `lastLoginDate` string — Last time the org owner logged in. - `teamRoles` string[] — List of team role types that the user have - `hasSubscribedToEmail` boolean — Determines if the user has opted in email subscription. - `hasSignedCuOptEULA` boolean — indicates if user has accepted CuOpt eula - `clientId` string — unique auth client id of this user. - `hasSignedOmniverseEULA` boolean — indicates if user has accepted Omniverse End User License Agreement. - `idpType` 'NVIDIA' | 'ENTERPRISE' — Type of IDP, Identity Provider. Used for login. - `hasProfile` boolean — indicate if user profile has been completed. - `hasSignedFleetCommandEULA` boolean — indicates if user has accepted Fleet Command End User License Agreement. - `hasSignedNVAIEEULA` boolean — indicates if user has accepted Fleet Command End User License Agreement. - `hasSignedThirdPartyRegistryShareEULA` boolean — indicates if user has consented to share their registration info with other parties ## Other responses - `302` — Found - `400` — Bad Request - `401` — Unauthorized - `402` — Payment Required - `403` — Forbidden - `404` — Not Found - `405` — Method Not Allowed - `409` — Object Exists - `415` — Unsupported Media Type - `422` — Unprocessable Entity - `429` — Too Many Requests - `451` — Unavailable For Legal Reasons - `500` — Internal Error - `501` — Not Implemented - `502` — Bad Gateway - `503` — Service Unavailable --- [API](https://skmtc.net/brevdev/apis/ngc-api-documentation.md) · [All operations](https://skmtc.net/brevdev/apis/ngc-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/brevdev/ngc-api-documentation/versions/7f0aa99cc03e/schema)