Network.Google.UserAccounts.Types

Service Configuration

userAccountsService :: Service

Default request referring to version beta of the Cloud User Accounts API. This contains the host and root path used as a starting point for constructing service requests.

OAuth Scopes

cloudPlatformReadOnlyScope :: OAuthScope

View your data across Google Cloud Platform services

cloudPlatformScope :: OAuthScope

View and manage your data across Google Cloud Platform services

cloudUseraccountsScope :: OAuthScope

Manage your Google Cloud User Accounts

cloudUseraccountsReadonlyScope :: OAuthScope

View your Google Cloud User Accounts

OperationWarningsItemDataItem

data OperationWarningsItemDataItem

Instances

Eq OperationWarningsItemDataItem

Data OperationWarningsItemDataItem

Show OperationWarningsItemDataItem

Generic OperationWarningsItemDataItem

ToJSON OperationWarningsItemDataItem

FromJSON OperationWarningsItemDataItem

type Rep OperationWarningsItemDataItem

operationWarningsItemDataItem :: OperationWarningsItemDataItem

Creates a value of OperationWarningsItemDataItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• owidiValue
• owidiKey

owidiValue :: Lens' OperationWarningsItemDataItem (Maybe Text)

Output Only

A warning data value corresponding to the key.

owidiKey :: Lens' OperationWarningsItemDataItem (Maybe Text)

Output Only

A key for the warning data.

OperationWarningsItemCode

data OperationWarningsItemCode

Output Only

The warning type identifier for this warning.

Constructors

DeprecatedResourceUsed

DEPRECATED_RESOURCE_USED

DiskSizeLargerThanImageSize

DISK_SIZE_LARGER_THAN_IMAGE_SIZE

InjectedKernelsDeprecated

INJECTED_KERNELS_DEPRECATED

NextHopAddressNotAssigned

NEXT_HOP_ADDRESS_NOT_ASSIGNED

NextHopCannotIPForward

NEXT_HOP_CANNOT_IP_FORWARD

NextHopInstanceNotFound

NEXT_HOP_INSTANCE_NOT_FOUND

NextHopInstanceNotOnNetwork

NEXT_HOP_INSTANCE_NOT_ON_NETWORK

NextHopNotRunning

NEXT_HOP_NOT_RUNNING

NotCriticalError

NOT_CRITICAL_ERROR

NoResultsOnPage

NO_RESULTS_ON_PAGE

RequiredTosAgreement

REQUIRED_TOS_AGREEMENT

ResourceNotDeleted

RESOURCE_NOT_DELETED

SingleInstancePropertyTemplate

SINGLE_INSTANCE_PROPERTY_TEMPLATE

Unreachable

UNREACHABLE

Instances

Enum OperationWarningsItemCode

Eq OperationWarningsItemCode

Data OperationWarningsItemCode

Ord OperationWarningsItemCode

Read OperationWarningsItemCode

Show OperationWarningsItemCode

Generic OperationWarningsItemCode

ToJSON OperationWarningsItemCode

FromJSON OperationWarningsItemCode

ToText OperationWarningsItemCode

FromText OperationWarningsItemCode

Hashable OperationWarningsItemCode

type Rep OperationWarningsItemCode

OperationList

data OperationList

Contains a list of Operation resources.

See: operationList smart constructor.

Instances

Eq OperationList

Data OperationList

Show OperationList

Generic OperationList

ToJSON OperationList

FromJSON OperationList

type Rep OperationList

operationList :: OperationList

Creates a value of OperationList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• olNextPageToken
• olKind
• olItems
• olSelfLink
• olId

olNextPageToken :: Lens' OperationList (Maybe Text)

Output Only

A token used to continue a truncate.

olKind :: Lens' OperationList Text

Output Only

Type of resource. Always compute#operations for Operations resource.

olItems :: Lens' OperationList [Operation]

Output Only

The Operation resources.

olSelfLink :: Lens' OperationList (Maybe Text)

Output Only

Server-defined URL for this resource.

olId :: Lens' OperationList (Maybe Text)

Output Only

Unique identifier for the resource; defined by the server.

Group

data Group

A Group resource.

See: group' smart constructor.

Instances

Eq Group

Data Group

Show Group

Generic Group

ToJSON Group

FromJSON Group

type Rep Group

group' :: Group

Creates a value of Group with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gKind
• gMembers
• gSelfLink
• gName
• gCreationTimestamp
• gId
• gDescription

gKind :: Lens' Group Text

Output Only

Type of the resource. Always clouduseraccounts#group for groups.

gMembers :: Lens' Group [Text]

Output Only

A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.

gSelfLink :: Lens' Group (Maybe Text)

Output Only

Server defined URL for the resource.

gName :: Lens' Group (Maybe Text)

Name of the resource; provided by the client when the resource is created.

gCreationTimestamp :: Lens' Group (Maybe Text)

Output Only

Creation timestamp in RFC3339 text format.

gId :: Lens' Group (Maybe Word64)

Output Only

Unique identifier for the resource; defined by the server.

gDescription :: Lens' Group (Maybe Text)

An optional textual description of the resource; provided by the client when the resource is created.

GroupList

data GroupList

Instances

Eq GroupList

Data GroupList

Show GroupList

Generic GroupList

ToJSON GroupList

FromJSON GroupList

type Rep GroupList

groupList :: GroupList

Creates a value of GroupList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• glNextPageToken
• glKind
• glItems
• glSelfLink
• glId

glNextPageToken :: Lens' GroupList (Maybe Text)

Output Only

A token used to continue a truncated list request.

glKind :: Lens' GroupList Text

Output Only

Type of resource. Always clouduseraccounts#groupList for lists of groups.

glItems :: Lens' GroupList [Group]

Output Only

A list of Group resources.

glSelfLink :: Lens' GroupList (Maybe Text)

Output Only

Server defined URL for this resource.

glId :: Lens' GroupList (Maybe Text)

Output Only

Unique identifier for the resource; defined by the server.

Operation

data Operation

An Operation resource, used to manage asynchronous API requests.

See: operation smart constructor.

Instances

Eq Operation

Data Operation

Show Operation

Generic Operation

ToJSON Operation

FromJSON Operation

type Rep Operation

operation :: Operation

Creates a value of Operation with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• oTargetId
• oStatus
• oInsertTime
• oProgress
• oStartTime
• oKind
• oError
• oHTTPErrorMessage
• oZone
• oWarnings
• oHTTPErrorStatusCode
• oUser
• oSelfLink
• oName
• oStatusMessage
• oCreationTimestamp
• oEndTime
• oId
• oOperationType
• oRegion
• oTargetLink
• oClientOperationId

oTargetId :: Lens' Operation (Maybe Word64)

Output Only

Unique target ID which identifies a particular incarnation of the target.

oStatus :: Lens' Operation (Maybe OperationStatus)

Output Only

Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.

oInsertTime :: Lens' Operation (Maybe Text)

Output Only

The time that this operation was requested. This is in RFC3339 text format.

oProgress :: Lens' Operation (Maybe Int32)

Output Only

An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.

oStartTime :: Lens' Operation (Maybe Text)

Output Only

The time that this operation was started by the server. This is in RFC3339 text format.

oKind :: Lens' Operation Text

Output Only

Type of the resource. Always compute#operation for Operation resources.

oError :: Lens' Operation (Maybe OperationError)

Output Only

If errors are generated during processing of the operation, this field will be populated.

oHTTPErrorMessage :: Lens' Operation (Maybe Text)

Output Only

If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.

oZone :: Lens' Operation (Maybe Text)

Output Only

URL of the zone where the operation resides.

oWarnings :: Lens' Operation [OperationWarningsItem]

Output Only

If warning messages are generated during processing of the operation, this field will be populated.

oHTTPErrorStatusCode :: Lens' Operation (Maybe Int32)

Output Only

If the operation fails, this field contains the HTTP error message that was returned, such as 404.

oUser :: Lens' Operation (Maybe Text)

Output Only

User who requested the operation, for example: user'example.com.

oSelfLink :: Lens' Operation (Maybe Text)

Output Only

Server-defined URL for the resource.

oName :: Lens' Operation (Maybe Text)

Output Only

Name of the resource.

oStatusMessage :: Lens' Operation (Maybe Text)

Output Only

An optional textual description of the current status of the operation.

oCreationTimestamp :: Lens' Operation (Maybe Text)

Output Only

Creation timestamp in RFC3339 text format.

oEndTime :: Lens' Operation (Maybe Text)

Output Only

The time that this operation was completed. This is in RFC3339 text format.

oId :: Lens' Operation (Maybe Word64)

Output Only

Unique identifier for the resource; defined by the server.

oOperationType :: Lens' Operation (Maybe Text)

Output Only

Type of the operation, such as insert, compute.instanceGroups.update, or compute.instanceGroups.delete.

oRegion :: Lens' Operation (Maybe Text)

Output Only

URL of the region where the operation resides. Only applicable for regional resources.

oTargetLink :: Lens' Operation (Maybe Text)

Output Only

URL of the resource the operation is mutating.

oClientOperationId :: Lens' Operation (Maybe Text)

Output Only

An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.

UserList

data UserList

Instances

Eq UserList

Data UserList

Show UserList

Generic UserList

ToJSON UserList

FromJSON UserList

type Rep UserList

userList :: UserList

Creates a value of UserList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ulNextPageToken
• ulKind
• ulItems
• ulSelfLink
• ulId

ulNextPageToken :: Lens' UserList (Maybe Text)

Output Only

A token used to continue a truncated list request.

ulKind :: Lens' UserList Text

Output Only

Type of resource. Always clouduseraccounts#userList for lists of users.

ulItems :: Lens' UserList [User]

Output Only

A list of User resources.

ulSelfLink :: Lens' UserList (Maybe Text)

Output Only

Server defined URL for this resource.

ulId :: Lens' UserList (Maybe Text)

Output Only

Unique identifier for the resource; defined by the server.

PublicKey

data PublicKey

A public key for authenticating to guests.

See: publicKey smart constructor.

Instances

Eq PublicKey

Data PublicKey

Show PublicKey

Generic PublicKey

ToJSON PublicKey

FromJSON PublicKey

type Rep PublicKey

publicKey :: PublicKey

Creates a value of PublicKey with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pkFingerprint
• pkKey
• pkCreationTimestamp
• pkExpirationTimestamp
• pkDescription

pkFingerprint :: Lens' PublicKey (Maybe Text)

Output Only

The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.

pkKey :: Lens' PublicKey (Maybe Text)

Public key text in SSH format, defined by RFC4253 section 6.6.

pkCreationTimestamp :: Lens' PublicKey (Maybe Text)

Output Only

Creation timestamp in RFC3339 text format.

pkExpirationTimestamp :: Lens' PublicKey (Maybe Text)

Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.

pkDescription :: Lens' PublicKey (Maybe Text)

An optional textual description of the resource; provided by the client when the resource is created.

OperationStatus

data OperationStatus

Output Only

Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.

Constructors

Done

DONE

Pending

PENDING

Running

RUNNING

Instances

Enum OperationStatus

Eq OperationStatus

Data OperationStatus

Ord OperationStatus

Read OperationStatus

Show OperationStatus

Generic OperationStatus

ToJSON OperationStatus

FromJSON OperationStatus

ToText OperationStatus

FromText OperationStatus

Hashable OperationStatus

type Rep OperationStatus

LinuxAccountViews

data LinuxAccountViews

A list of all Linux accounts for this project. This API is only used by Compute Engine virtual machines to get information about user accounts for a project or instance. Linux resources are read-only views into users and groups managed by the Compute Engine Accounts API.

See: linuxAccountViews smart constructor.

Instances

Eq LinuxAccountViews

Data LinuxAccountViews

Show LinuxAccountViews

Generic LinuxAccountViews

ToJSON LinuxAccountViews

FromJSON LinuxAccountViews

type Rep LinuxAccountViews

linuxAccountViews :: LinuxAccountViews

Creates a value of LinuxAccountViews with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lavUserViews
• lavKind
• lavGroupViews

lavUserViews :: Lens' LinuxAccountViews [LinuxUserView]

Output Only

A list of all users within a project.

lavKind :: Lens' LinuxAccountViews Text

Output Only

Type of the resource. Always clouduseraccounts#linuxAccountViews for Linux resources.

lavGroupViews :: Lens' LinuxAccountViews [LinuxGroupView]

Output Only

A list of all groups within a project.

User

data User

A User resource.

See: user smart constructor.

Instances

Eq User

Data User

Show User

Generic User

ToJSON User

FromJSON User

type Rep User

user :: User

Creates a value of User with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• uGroups
• uPublicKeys
• uKind
• uOwner
• uSelfLink
• uName
• uCreationTimestamp
• uId
• uDescription

uGroups :: Lens' User [Text]

Output Only

A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.

uPublicKeys :: Lens' User [PublicKey]

Output Only

Public keys that this user may use to login.

uKind :: Lens' User Text

Output Only

Type of the resource. Always clouduseraccounts#user for users.

uOwner :: Lens' User (Maybe Text)

Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.

uSelfLink :: Lens' User (Maybe Text)

Output Only

Server defined URL for the resource.

uName :: Lens' User (Maybe Text)

Name of the resource; provided by the client when the resource is created.

uCreationTimestamp :: Lens' User (Maybe Text)

Output Only

Creation timestamp in RFC3339 text format.

uId :: Lens' User (Maybe Word64)

Output Only

Unique identifier for the resource; defined by the server.

uDescription :: Lens' User (Maybe Text)

An optional textual description of the resource; provided by the client when the resource is created.

GroupsAddMemberRequest

data GroupsAddMemberRequest

Instances

Eq GroupsAddMemberRequest

Data GroupsAddMemberRequest

Show GroupsAddMemberRequest

Generic GroupsAddMemberRequest

ToJSON GroupsAddMemberRequest

FromJSON GroupsAddMemberRequest

type Rep GroupsAddMemberRequest

groupsAddMemberRequest :: GroupsAddMemberRequest

Creates a value of GroupsAddMemberRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gamrUsers

gamrUsers :: Lens' GroupsAddMemberRequest [Text]

Fully-qualified URLs of the User resources to add.

LinuxGroupView

data LinuxGroupView

A detailed view of a Linux group.

See: linuxGroupView smart constructor.

Instances

Eq LinuxGroupView

Data LinuxGroupView

Show LinuxGroupView

Generic LinuxGroupView

ToJSON LinuxGroupView

FromJSON LinuxGroupView

type Rep LinuxGroupView

linuxGroupView :: LinuxGroupView

Creates a value of LinuxGroupView with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lgvMembers
• lgvGid
• lgvGroupName

lgvMembers :: Lens' LinuxGroupView [Text]

Output Only

List of user accounts that belong to the group.

lgvGid :: Lens' LinuxGroupView (Maybe Word32)

Output Only

The Group ID.

lgvGroupName :: Lens' LinuxGroupView (Maybe Text)

Output Only

Group name.

LinuxUserView

data LinuxUserView

A detailed view of a Linux user account.

See: linuxUserView smart constructor.

Instances

Eq LinuxUserView

Data LinuxUserView

Show LinuxUserView

Generic LinuxUserView

ToJSON LinuxUserView

FromJSON LinuxUserView

type Rep LinuxUserView

linuxUserView :: LinuxUserView

Creates a value of LinuxUserView with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• luvGecos
• luvUid
• luvUsername
• luvShell
• luvGid
• luvHomeDirectory

luvGecos :: Lens' LinuxUserView (Maybe Text)

Output Only

The GECOS (user information) entry for this account.

luvUid :: Lens' LinuxUserView (Maybe Word32)

Output Only

User ID.

luvUsername :: Lens' LinuxUserView (Maybe Text)

Output Only

The username of the account.

luvShell :: Lens' LinuxUserView (Maybe Text)

Output Only

The path to the login shell for this account.

luvGid :: Lens' LinuxUserView (Maybe Word32)

Output Only

User's default group ID.

luvHomeDirectory :: Lens' LinuxUserView (Maybe Text)

Output Only

The path to the home directory for this account.

LinuxGetLinuxAccountViewsResponse

data LinuxGetLinuxAccountViewsResponse

Instances

Eq LinuxGetLinuxAccountViewsResponse

Data LinuxGetLinuxAccountViewsResponse

Show LinuxGetLinuxAccountViewsResponse

Generic LinuxGetLinuxAccountViewsResponse

ToJSON LinuxGetLinuxAccountViewsResponse

FromJSON LinuxGetLinuxAccountViewsResponse

type Rep LinuxGetLinuxAccountViewsResponse

linuxGetLinuxAccountViewsResponse :: LinuxGetLinuxAccountViewsResponse

Creates a value of LinuxGetLinuxAccountViewsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lglavrResource

lglavrResource :: Lens' LinuxGetLinuxAccountViewsResponse (Maybe LinuxAccountViews)

Output Only

A list of authorized user accounts and groups.

OperationError

data OperationError

Output Only

If errors are generated during processing of the operation, this field will be populated.

See: operationError smart constructor.

Instances

Eq OperationError

Data OperationError

Show OperationError

Generic OperationError

ToJSON OperationError

FromJSON OperationError

type Rep OperationError

operationError :: OperationError

Creates a value of OperationError with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• oeErrors

oeErrors :: Lens' OperationError [OperationErrorErrorsItem]

Output Only

The array of errors encountered while processing this operation.

LinuxGetAuthorizedKeysViewResponse

data LinuxGetAuthorizedKeysViewResponse

Instances

Eq LinuxGetAuthorizedKeysViewResponse

Data LinuxGetAuthorizedKeysViewResponse

Show LinuxGetAuthorizedKeysViewResponse

Generic LinuxGetAuthorizedKeysViewResponse

ToJSON LinuxGetAuthorizedKeysViewResponse

FromJSON LinuxGetAuthorizedKeysViewResponse

type Rep LinuxGetAuthorizedKeysViewResponse

linuxGetAuthorizedKeysViewResponse :: LinuxGetAuthorizedKeysViewResponse

Creates a value of LinuxGetAuthorizedKeysViewResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lgakvrResource

lgakvrResource :: Lens' LinuxGetAuthorizedKeysViewResponse (Maybe AuthorizedKeysView)

Output Only

A list of authorized public keys for a user.

OperationErrorErrorsItem

data OperationErrorErrorsItem

Instances

Eq OperationErrorErrorsItem

Data OperationErrorErrorsItem

Show OperationErrorErrorsItem

Generic OperationErrorErrorsItem

ToJSON OperationErrorErrorsItem

FromJSON OperationErrorErrorsItem

type Rep OperationErrorErrorsItem

operationErrorErrorsItem :: OperationErrorErrorsItem

Creates a value of OperationErrorErrorsItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• oeeiLocation
• oeeiCode
• oeeiMessage

oeeiLocation :: Lens' OperationErrorErrorsItem (Maybe Text)

Output Only

Indicates the field in the request which caused the error. This property is optional.

oeeiCode :: Lens' OperationErrorErrorsItem (Maybe Text)

Output Only

The error type identifier for this error.

oeeiMessage :: Lens' OperationErrorErrorsItem (Maybe Text)

Output Only

An optional, human-readable error message.

GroupsRemoveMemberRequest

data GroupsRemoveMemberRequest

Instances

Eq GroupsRemoveMemberRequest

Data GroupsRemoveMemberRequest

Show GroupsRemoveMemberRequest

Generic GroupsRemoveMemberRequest

ToJSON GroupsRemoveMemberRequest

FromJSON GroupsRemoveMemberRequest

type Rep GroupsRemoveMemberRequest

groupsRemoveMemberRequest :: GroupsRemoveMemberRequest

Creates a value of GroupsRemoveMemberRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• grmrUsers

grmrUsers :: Lens' GroupsRemoveMemberRequest [Text]

Fully-qualified URLs of the User resources to remove.

AuthorizedKeysView

data AuthorizedKeysView

A list of authorized public keys for a user account.

See: authorizedKeysView smart constructor.

Instances

Eq AuthorizedKeysView

Data AuthorizedKeysView

Show AuthorizedKeysView

Generic AuthorizedKeysView

ToJSON AuthorizedKeysView

FromJSON AuthorizedKeysView

type Rep AuthorizedKeysView

authorizedKeysView :: AuthorizedKeysView

Creates a value of AuthorizedKeysView with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• akvSudoer
• akvKeys

akvSudoer :: Lens' AuthorizedKeysView (Maybe Bool)

Output Only

Whether the user has the ability to elevate on the instance that requested the authorized keys.

akvKeys :: Lens' AuthorizedKeysView [Text]

Output Only

The list of authorized public keys in SSH format.

OperationWarningsItem

data OperationWarningsItem

Instances

Eq OperationWarningsItem

Data OperationWarningsItem

Show OperationWarningsItem

Generic OperationWarningsItem

ToJSON OperationWarningsItem

FromJSON OperationWarningsItem

type Rep OperationWarningsItem

operationWarningsItem :: OperationWarningsItem

Creates a value of OperationWarningsItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• owiData
• owiCode
• owiMessage

owiData :: Lens' OperationWarningsItem [OperationWarningsItemDataItem]

Output Only

Metadata for this warning in key: value format.

owiCode :: Lens' OperationWarningsItem (Maybe OperationWarningsItemCode)

Output Only

The warning type identifier for this warning.

owiMessage :: Lens' OperationWarningsItem (Maybe Text)

Output Only

Optional human-readable details for this warning.