DirectoryGroup

Used to retrieve a list of all groups of a domain (or an individual group) Endpoints: /admin/directory/v1/groups /admin/directory/v1/groups/{groupId}

🔗↗️

DirectoryUser

Used to retrieve users metadata Endpoints: /admin/directory/v1/users /admin/directory/v1/users/{accountId}

🔗↗️

DirectoryMember

Used to retrieve a list of members of a group Endpoints: /admin/directory/v1/groups/{groupId}/members,

🔗↗️

adminCreated

Boolean

aliases

List of String

Raw example: ["alice@acme.com","aliceatwork@acme.com"] Sanitized example:

[
	{
		"scope":"email",
		"domain":"acme.com",
		"hash":"aT3usZghgyWmDoXRncq5qhmQJQMjY49xDJylpM4TyYI"
	},
	{
		"scope":"email",
		"domain":"acme.com",
		"hash":"9vNzNM4KMF1Imj6P8ia4PBu6zM16s6A-6VgxE9-vASs"
	}
]

description

String

directMembersCount

Long

email

String

Raw example: alice@acme.com Sanitized example:

{
	"scope":"email",
	"domain":"acme.com",
	"hash":"aT3usZghgyWmDoXRncq5qhmQJQMjY49xDJylpM4TyYI"
}

etag

String

id

String

kind

String

name

String

nonEditableAliases

List of String

Raw example: ["alice@acme.com","aliceatwork@acme.com"] Sanitized example:

[
	{
		"scope":"email",
		"domain":"acme.com",
		"hash":"aT3usZghgyWmDoXRncq5qhmQJQMjY49xDJylpM4TyYI"
	},
	{
		"scope":"email",
		"domain":"acme.com",
		"hash":"9vNzNM4KMF1Imj6P8ia4PBu6zM16s6A-6VgxE9-vASs"
	}
]

agreedToTerms

Boolean

aliases

List of String

Raw example: ["alice@acme.com","aliceatwork@acme.com"] Sanitized example:

[
	{
		"scope":"email",
		"domain":"acme.com",
		"hash":"aT3usZghgyWmDoXRncq5qhmQJQMjY49xDJylpM4TyYI"
	},
	{
		"scope":"email",
		"domain":"acme.com",
		"hash":"9vNzNM4KMF1Imj6P8ia4PBu6zM16s6A-6VgxE9-vASs"
	}
]

archived

Boolean

creationTime

ZonedDateTime

customerId

String

deletionTime

ZonedDateTime

emails[]

List of DirectoryEmail

emails[].address

String

Raw example: alice@acme.com Sanitized example:

{
	"scope":"email",
	"domain":"acme.com",
	"hash":"aT3usZghgyWmDoXRncq5qhmQJQMjY49xDJylpM4TyYI"
}

emails[].customType

String

emails[].primary

Boolean

emails[].type

String

etag

String

externalIds[]

List of ExternalId

externalIds[].customType

String

externalIds[].type

String

externalIds[].value

String

gender

Gender

gender.type

String

id

String

ims

N/A

includeInGlobalAddressList

Boolean

isAdmin

Boolean

isDelegatedAdmin

Boolean

isEnforcedIn2Sv

Boolean

isEnrolledIn2Sv

Boolean

isMailboxSetup

Boolean

languages[]

List of Language

languages[].customLanguage

String

languages[].languageCode

String

lastLoginTime

ZonedDateTime

locations[]

List of Location

locations[].area

String

locations[].buildingId

String

locations[].customType

String

locations[].deskCode

String

locations[].floorName

String

locations[].floorSection

String

locations[].type

String

name

DirectoryPersonName

name.familyName

String

name.fullName

String

name.givenName

String

nonEditableAliases

List of String

Raw example: ["alice@acme.com","aliceatwork@acme.com"] Sanitized example:

[
	{
		"scope":"email",
		"domain":"acme.com",
		"hash":"aT3usZghgyWmDoXRncq5qhmQJQMjY49xDJylpM4TyYI"
	},
	{
		"scope":"email",
		"domain":"acme.com",
		"hash":"9vNzNM4KMF1Imj6P8ia4PBu6zM16s6A-6VgxE9-vASs"
	}
]

orgUnitPath

String

organizations[]

List of Organization

organizations[].costCenter

String

organizations[].customType

String

organizations[].department

String

organizations[].description

String

organizations[].domain

String

organizations[].fullTimeEquivalent

Integer

organizations[].location

String

organizations[].name

String

organizations[].primary

Boolean

organizations[].symbol

String

organizations[].title

String

organizations[].type

String

posixAccounts

N/A

primaryEmail

String

Raw example: alice@acme.com Sanitized example:

{
	"scope":"email",
	"domain":"acme.com",
	"hash":"aT3usZghgyWmDoXRncq5qhmQJQMjY49xDJylpM4TyYI"
}

recoveryEmail

N/A

recoveryPhone

N/A

relations

N/A

sshPublicKeys

N/A

suspended

Boolean

suspensionReason

String

thumbnailPhotoEtag

String

thumbnailPhotoUrl

String

websites

N/A

deliverySettings

String

email

String

Raw example: alice@acme.com Sanitized example:

{
	"scope":"email",
	"domain":"acme.com",
	"hash":"aT3usZghgyWmDoXRncq5qhmQJQMjY49xDJylpM4TyYI"
}

etag

String

id

String

kind

String

role

String

status

String

type

String