Get data about the NGC external user group of the training event

GET

https://api.dsx-air.nvidia.com/api/v3/trainings/:id/external-user-group/

GET

/api/v3/trainings/:id/external-user-group/

curl https://api.dsx-air.nvidia.com/api/v3/trainings/id/external-user-group/ \
     -H "Authorization: Bearer <token>"

{
  "userGroupId": "string",
  "resourceGroup": "string",
  "name": "string",
  "description": "string",
  "idpListLocked": true,
  "requireMatchingEmail": true,
  "isUserGroupAdmin": true,
  "serviceRoles": [
    "string"
  ],
  "confirmedUsers": [
    {
      "email": "string",
      "idpName": "string",
      "isAdmin": true,
      "userSince": "string",
      "userId": "string",
      "idpType": "string",
      "lastLoginDate": "string"
    }
  ],
  "pendingInvitations": [
    {
      "email": "string",
      "userRole": "string",
      "dateInvited": "string",
      "expiresAt": "string"
    }
  ],
  "type": "string",
  "orgName": "string",
  "companyName": "string",
  "groupContactEmail": "string",
  "permissionSetDesc": "string",
  "startDate": "string",
  "endDate": "string"
}

Get data about NGC external user group associated with the training. This will make an external API call to NGC to obtain this data.

Required roles (all): air_instructor, air_org_admin, user_admin

Additional permissions:

Only the instructor who created this training may perform this action.
The client must have the NCA ‘Administrator’ role set in the NCA account associated with the NGC Organization.

Get data about NGC external user group associated with the training. This will make an external API call to NGC to obtain this data. **Required roles (all):** `air_instructor`, `air_org_admin`, `user_admin` **Additional permissions:** - Only the instructor who created this training may perform this action. - The client must have the NCA 'Administrator' role set in the NCA account associated with the NGC Organization.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequiredformat: "uuid"

A UUID string identifying this training.

Response

userGroupIdstring

Unique identifier for the NGC external user group.

resourceGroupstring

Resource group name.

namestring

Name of the external user group.

descriptionstring

Description of the user group.

idpListLockedboolean

Whether the identity provider list is locked.

requireMatchingEmailboolean

Whether matching email is required.

isUserGroupAdminboolean

Whether the requester is a user group admin.

serviceRoleslist of strings

List of service roles for the group.

confirmedUserslist of objects

List of confirmed users in the group.

pendingInvitationslist of objects

List of pending invitations.

typestring

Type of the user group.

orgNamestringOptional

NGC organization name.

companyNamestringOptional

Company name.

groupContactEmailstringOptional

Contact email for the group.

permissionSetDescstringOptional

Description of the permission set.

startDatestringOptional

Start date of the user group.

endDatestringOptional

End date of the user group.

Errors

403

Forbidden Error

404

Not Found Error

500

Internal Server Error