| Copyright | (c) 2015-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.Google.CloudIdentity.Types
Contents
Description
Synopsis
- cloudIdentityService :: ServiceConfig
- data LookupMembershipNameResponse
- lookupMembershipNameResponse :: LookupMembershipNameResponse
- lmnrName :: Lens' LookupMembershipNameResponse (Maybe Text)
- data Status
- status :: Status
- sDetails :: Lens' Status [StatusDetailsItem]
- sCode :: Lens' Status (Maybe Int32)
- sMessage :: Lens' Status (Maybe Text)
- data Group
- group' :: Group
- gParent :: Lens' Group (Maybe Text)
- gGroupKey :: Lens' Group (Maybe EntityKey)
- gUpdateTime :: Lens' Group (Maybe UTCTime)
- gName :: Lens' Group (Maybe Text)
- gDisplayName :: Lens' Group (Maybe Text)
- gLabels :: Lens' Group (Maybe GroupLabels)
- gDescription :: Lens' Group (Maybe Text)
- gCreateTime :: Lens' Group (Maybe UTCTime)
- data Membership
- membership :: Membership
- mRoles :: Lens' Membership [MembershipRole]
- mUpdateTime :: Lens' Membership (Maybe UTCTime)
- mName :: Lens' Membership (Maybe Text)
- mPreferredMemberKey :: Lens' Membership (Maybe EntityKey)
- mCreateTime :: Lens' Membership (Maybe UTCTime)
- data Operation
- operation :: Operation
- oDone :: Lens' Operation (Maybe Bool)
- oError :: Lens' Operation (Maybe Status)
- oResponse :: Lens' Operation (Maybe OperationResponse)
- oName :: Lens' Operation (Maybe Text)
- oMetadata :: Lens' Operation (Maybe OperationMetadata)
- data ListGroupsResponse
- listGroupsResponse :: ListGroupsResponse
- lgrGroups :: Lens' ListGroupsResponse [Group]
- lgrNextPageToken :: Lens' ListGroupsResponse (Maybe Text)
- data StatusDetailsItem
- statusDetailsItem :: HashMap Text JSONValue -> StatusDetailsItem
- sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue)
- data MembershipRole
- membershipRole :: MembershipRole
- mrName :: Lens' MembershipRole (Maybe Text)
- data LookupGroupNameResponse
- lookupGroupNameResponse :: LookupGroupNameResponse
- lgnrName :: Lens' LookupGroupNameResponse (Maybe Text)
- data SearchGroupsResponse
- searchGroupsResponse :: SearchGroupsResponse
- sgrGroups :: Lens' SearchGroupsResponse [Group]
- sgrNextPageToken :: Lens' SearchGroupsResponse (Maybe Text)
- data EntityKey
- entityKey :: EntityKey
- ekNamespace :: Lens' EntityKey (Maybe Text)
- ekId :: Lens' EntityKey (Maybe Text)
- data Xgafv
- data GroupLabels
- groupLabels :: HashMap Text Text -> GroupLabels
- glAddtional :: Lens' GroupLabels (HashMap Text Text)
- data ListMembershipsResponse
- listMembershipsResponse :: ListMembershipsResponse
- lmrNextPageToken :: Lens' ListMembershipsResponse (Maybe Text)
- lmrMemberships :: Lens' ListMembershipsResponse [Membership]
- data OperationMetadata
- operationMetadata :: HashMap Text JSONValue -> OperationMetadata
- omAddtional :: Lens' OperationMetadata (HashMap Text JSONValue)
- data OperationResponse
- operationResponse :: HashMap Text JSONValue -> OperationResponse
- orAddtional :: Lens' OperationResponse (HashMap Text JSONValue)
Service Configuration
cloudIdentityService :: ServiceConfig Source #
Default request referring to version v1 of the Cloud Identity API. This contains the host and root path used as a starting point for constructing service requests.
LookupMembershipNameResponse
data LookupMembershipNameResponse Source #
Instances
lookupMembershipNameResponse :: LookupMembershipNameResponse Source #
Creates a value of LookupMembershipNameResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lmnrName :: Lens' LookupMembershipNameResponse (Maybe Text) Source #
Resource name of the Membership being looked up. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique ID assigned to the Group to which Membership belongs to, and `member_id` is the unique ID assigned to the member.
Status
The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.
See: status smart constructor.
Instances
| Eq Status Source # | |
| Data Status Source # | |
Defined in Network.Google.CloudIdentity.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Status -> c Status # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Status # toConstr :: Status -> Constr # dataTypeOf :: Status -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Status) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Status) # gmapT :: (forall b. Data b => b -> b) -> Status -> Status # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r # gmapQ :: (forall d. Data d => d -> u) -> Status -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Status -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Status -> m Status # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status # | |
| Show Status Source # | |
| Generic Status Source # | |
| ToJSON Status Source # | |
Defined in Network.Google.CloudIdentity.Types.Product | |
| FromJSON Status Source # | |
| type Rep Status Source # | |
Defined in Network.Google.CloudIdentity.Types.Product type Rep Status = D1 (MetaData "Status" "Network.Google.CloudIdentity.Types.Product" "gogol-cloudidentity-0.4.0-70dkCNBCHSj1yskFkcCZhj" False) (C1 (MetaCons "Status'" PrefixI True) (S1 (MetaSel (Just "_sDetails") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [StatusDetailsItem])) :*: (S1 (MetaSel (Just "_sCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_sMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) | |
sDetails :: Lens' Status [StatusDetailsItem] Source #
A list of messages that carry the error details. There is a common set of message types for APIs to use.
sCode :: Lens' Status (Maybe Int32) Source #
The status code, which should be an enum value of google.rpc.Code.
sMessage :: Lens' Status (Maybe Text) Source #
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Group
Resource representing a Group.
See: group' smart constructor.
Instances
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:
gParent :: Lens' Group (Maybe Text) Source #
The entity under which this Group resides in Cloud Identity resource hierarchy. Must be set when creating a Group, read-only afterwards. Currently allowed types: `identitysources`.
gGroupKey :: Lens' Group (Maybe EntityKey) Source #
EntityKey of the Group. Must be set when creating a Group, read-only afterwards.
gUpdateTime :: Lens' Group (Maybe UTCTime) Source #
The time when the Group was last updated. Output only.
gName :: Lens' Group (Maybe Text) Source #
Resource name of the Group in the format: `groups/{group_id}`, where group_id is the unique ID assigned to the Group. Must be left blank while creating a Group.
gLabels :: Lens' Group (Maybe GroupLabels) Source #
`Required`. Labels for Group resource. For creating Groups under a namespace, set label key to 'labels/system/groups/external' and label value as empty.
gDescription :: Lens' Group (Maybe Text) Source #
An extended description to help users determine the purpose of a Group. For example, you can include information about who should join the Group, the types of messages to send to the Group, links to FAQs about the Group, or related Groups. Maximum length is 4,096 characters.
gCreateTime :: Lens' Group (Maybe UTCTime) Source #
The time when the Group was created. Output only.
Membership
data Membership Source #
Resource representing a Membership within a Group
See: membership smart constructor.
Instances
membership :: Membership Source #
Creates a value of Membership with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mRoles :: Lens' Membership [MembershipRole] Source #
Roles for a member within the Group. Currently supported MembershipRoles: `"MEMBER"`.
mUpdateTime :: Lens' Membership (Maybe UTCTime) Source #
Last updated timestamp of the Membership. Output only.
mName :: Lens' Membership (Maybe Text) Source #
Resource name of the Membership in the format: `groups/{group_id}/memberships/{member_id}`, where group_id is the unique ID assigned to the Group to which Membership belongs to, and member_id is the unique ID assigned to the member Must be left blank while creating a Membership.
mPreferredMemberKey :: Lens' Membership (Maybe EntityKey) Source #
EntityKey of the entity to be added as the member. Must be set while creating a Membership, read-only afterwards. Currently allowed entity types: `Users`, `Groups`.
mCreateTime :: Lens' Membership (Maybe UTCTime) Source #
Creation timestamp of the Membership. Output only.
Operation
This resource represents a long-running operation that is the result of a network API call.
See: operation smart constructor.
Instances
oDone :: Lens' Operation (Maybe Bool) Source #
If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
oError :: Lens' Operation (Maybe Status) Source #
The error result of the operation in case of failure or cancellation.
oResponse :: Lens' Operation (Maybe OperationResponse) Source #
The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
oName :: Lens' Operation (Maybe Text) Source #
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
oMetadata :: Lens' Operation (Maybe OperationMetadata) Source #
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
ListGroupsResponse
data ListGroupsResponse Source #
Response message for ListGroups operation.
See: listGroupsResponse smart constructor.
Instances
listGroupsResponse :: ListGroupsResponse Source #
Creates a value of ListGroupsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lgrGroups :: Lens' ListGroupsResponse [Group] Source #
Groups returned in response to list request. The results are not sorted.
lgrNextPageToken :: Lens' ListGroupsResponse (Maybe Text) Source #
Token to retrieve the next page of results, or empty if there are no more results available for listing.
StatusDetailsItem
data StatusDetailsItem Source #
Instances
Arguments
| :: HashMap Text JSONValue | |
| -> StatusDetailsItem |
Creates a value of StatusDetailsItem with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
MembershipRole
data MembershipRole Source #
Resource representing a role within a Membership.
See: membershipRole smart constructor.
Instances
membershipRole :: MembershipRole Source #
Creates a value of MembershipRole with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mrName :: Lens' MembershipRole (Maybe Text) Source #
MembershipRole in string format. Currently supported MembershipRoles: `"MEMBER"`.
LookupGroupNameResponse
data LookupGroupNameResponse Source #
Instances
lookupGroupNameResponse :: LookupGroupNameResponse Source #
Creates a value of LookupGroupNameResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lgnrName :: Lens' LookupGroupNameResponse (Maybe Text) Source #
Resource name of the Group in the format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group.
SearchGroupsResponse
data SearchGroupsResponse Source #
Instances
searchGroupsResponse :: SearchGroupsResponse Source #
Creates a value of SearchGroupsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sgrNextPageToken :: Lens' SearchGroupsResponse (Maybe Text) Source #
Token to retrieve the next page of results, or empty if there are no more results available for specified query.
EntityKey
An EntityKey uniquely identifies an Entity. Namespaces are used to provide isolation for IDs. A single ID can be reused across namespaces but the combination of a namespace and an ID must be unique.
See: entityKey smart constructor.
Instances
| Eq EntityKey Source # | |
| Data EntityKey Source # | |
Defined in Network.Google.CloudIdentity.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EntityKey -> c EntityKey # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EntityKey # toConstr :: EntityKey -> Constr # dataTypeOf :: EntityKey -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c EntityKey) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EntityKey) # gmapT :: (forall b. Data b => b -> b) -> EntityKey -> EntityKey # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EntityKey -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EntityKey -> r # gmapQ :: (forall d. Data d => d -> u) -> EntityKey -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> EntityKey -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> EntityKey -> m EntityKey # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EntityKey -> m EntityKey # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EntityKey -> m EntityKey # | |
| Show EntityKey Source # | |
| Generic EntityKey Source # | |
| ToJSON EntityKey Source # | |
Defined in Network.Google.CloudIdentity.Types.Product | |
| FromJSON EntityKey Source # | |
| type Rep EntityKey Source # | |
Defined in Network.Google.CloudIdentity.Types.Product type Rep EntityKey = D1 (MetaData "EntityKey" "Network.Google.CloudIdentity.Types.Product" "gogol-cloudidentity-0.4.0-70dkCNBCHSj1yskFkcCZhj" False) (C1 (MetaCons "EntityKey'" PrefixI True) (S1 (MetaSel (Just "_ekNamespace") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ekId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) | |
entityKey :: EntityKey Source #
Creates a value of EntityKey with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ekNamespace :: Lens' EntityKey (Maybe Text) Source #
Namespaces provide isolation for IDs, so an ID only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `"identitysources/{identity_source_id}"` is created corresponding to every Identity Source `identity_source_id`.
ekId :: Lens' EntityKey (Maybe Text) Source #
The ID of the entity within the given namespace. The ID must be unique within its namespace.
Xgafv
V1 error format.
Instances
GroupLabels
data GroupLabels Source #
`Required`. Labels for Group resource. For creating Groups under a namespace, set label key to 'labels/system/groups/external' and label value as empty.
See: groupLabels smart constructor.
Instances
Arguments
| :: HashMap Text Text | |
| -> GroupLabels |
Creates a value of GroupLabels with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ListMembershipsResponse
data ListMembershipsResponse Source #
Instances
listMembershipsResponse :: ListMembershipsResponse Source #
Creates a value of ListMembershipsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lmrNextPageToken :: Lens' ListMembershipsResponse (Maybe Text) Source #
Token to retrieve the next page of results, or empty if there are no more results available for listing.
lmrMemberships :: Lens' ListMembershipsResponse [Membership] Source #
List of Memberships.
OperationMetadata
data OperationMetadata Source #
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
See: operationMetadata smart constructor.
Instances
Arguments
| :: HashMap Text JSONValue | |
| -> OperationMetadata |
Creates a value of OperationMetadata with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
omAddtional :: Lens' OperationMetadata (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
OperationResponse
data OperationResponse Source #
The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
See: operationResponse smart constructor.
Instances
Arguments
| :: HashMap Text JSONValue | |
| -> OperationResponse |
Creates a value of OperationResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
orAddtional :: Lens' OperationResponse (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.