resources.cloudidentity.v1.json Maven / Gradle / Ivy
{
"ownerName": "Google",
"resources": {
"groups": {
"resources": {
"memberships": {
"methods": {
"delete": {
"path": "v1/{+name}",
"id": "cloudidentity.groups.memberships.delete",
"description": "Deletes a Membership.",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
"httpMethod": "DELETE",
"parameters": {
"name": {
"pattern": "^groups/[^/]+/memberships/[^/]+$",
"location": "path",
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nMembership to be deleted.\n\nFormat: `groups/{group_id}/memberships/{member_id}`, where `group_id` is\nthe unique ID assigned to the Group to which Membership belongs to, and\nmember_id is the unique ID assigned to the member.",
"required": true,
"type": "string"
}
},
"flatPath": "v1/groups/{groupsId}/memberships/{membershipsId}"
},
"get": {
"path": "v1/{+name}",
"id": "cloudidentity.groups.memberships.get",
"description": "Retrieves a Membership.",
"response": {
"$ref": "Membership"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"parameters": {
"name": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nMembership to be retrieved.\n\nFormat: `groups/{group_id}/memberships/{member_id}`, where `group_id` is\nthe unique id assigned to the Group to which Membership belongs to, and\n`member_id` is the unique ID assigned to the member.",
"required": true,
"type": "string",
"pattern": "^groups/[^/]+/memberships/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/groups/{groupsId}/memberships/{membershipsId}"
},
"list": {
"id": "cloudidentity.groups.memberships.list",
"path": "v1/{+parent}/memberships",
"description": "List Memberships within a Group.",
"httpMethod": "GET",
"response": {
"$ref": "ListMembershipsResponse"
},
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup to list Memberships within.\n\nFormat: `groups/{group_id}`, where `group_id` is the unique ID assigned to\nthe Group.",
"required": true,
"type": "string",
"pattern": "^groups/[^/]+$",
"location": "path"
},
"pageToken": {
"description": "The next_page_token value returned from a previous list request, if any.",
"type": "string",
"location": "query"
},
"pageSize": {
"description": "The default page size is 200 (max 1000) for the BASIC view, and 50\n(max 500) for the FULL view.",
"format": "int32",
"type": "integer",
"location": "query"
},
"view": {
"enum": [
"VIEW_UNSPECIFIED",
"BASIC",
"FULL"
],
"description": "Membership resource view to be returned. Defaults to View.BASIC.",
"type": "string",
"location": "query"
}
},
"flatPath": "v1/groups/{groupsId}/memberships"
},
"create": {
"request": {
"$ref": "Membership"
},
"description": "Creates a Membership.",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"parameters": {
"parent": {
"pattern": "^groups/[^/]+$",
"location": "path",
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup to create Membership within. Format: `groups/{group_id}`, where\n`group_id` is the unique ID assigned to the Group.",
"required": true,
"type": "string"
}
},
"flatPath": "v1/groups/{groupsId}/memberships",
"path": "v1/{+parent}/memberships",
"id": "cloudidentity.groups.memberships.create"
},
"lookup": {
"httpMethod": "GET",
"response": {
"$ref": "LookupMembershipNameResponse"
},
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup to lookup Membership within.\n\nFormat: `groups/{group_id}`, where `group_id` is the unique ID assigned to\nthe Group.",
"required": true,
"type": "string",
"pattern": "^groups/[^/]+$",
"location": "path"
},
"memberKey.id": {
"description": "The ID of the entity within the given namespace. The ID must be unique\nwithin its namespace.",
"type": "string",
"location": "query"
},
"memberKey.namespace": {
"description": "Namespaces provide isolation for IDs, so an ID only needs to be unique\nwithin its namespace.\n\nNamespaces are currently only created as part of IdentitySource creation\nfrom Admin Console. A namespace `\"identitysources/{identity_source_id}\"` is\ncreated corresponding to every Identity Source `identity_source_id`.",
"type": "string",
"location": "query"
}
},
"flatPath": "v1/groups/{groupsId}/memberships:lookup",
"id": "cloudidentity.groups.memberships.lookup",
"path": "v1/{+parent}/memberships:lookup",
"description": "Looks up [resource\nname](https://cloud.google.com/apis/design/resource_names) of a Membership\nwithin a Group by member's EntityKey."
}
}
}
},
"methods": {
"lookup": {
"path": "v1/groups:lookup",
"id": "cloudidentity.groups.lookup",
"description": "Looks up [resource\nname](https://cloud.google.com/apis/design/resource_names) of a Group by\nits EntityKey.",
"response": {
"$ref": "LookupGroupNameResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {
"groupKey.id": {
"description": "The ID of the entity within the given namespace. The ID must be unique\nwithin its namespace.",
"type": "string",
"location": "query"
},
"groupKey.namespace": {
"location": "query",
"description": "Namespaces provide isolation for IDs, so an ID only needs to be unique\nwithin its namespace.\n\nNamespaces are currently only created as part of IdentitySource creation\nfrom Admin Console. A namespace `\"identitysources/{identity_source_id}\"` is\ncreated corresponding to every Identity Source `identity_source_id`.",
"type": "string"
}
},
"flatPath": "v1/groups:lookup"
},
"create": {
"response": {
"$ref": "Operation"
},
"parameterOrder": [],
"httpMethod": "POST",
"parameters": {},
"flatPath": "v1/groups",
"path": "v1/groups",
"id": "cloudidentity.groups.create",
"request": {
"$ref": "Group"
},
"description": "Creates a Group."
},
"search": {
"httpMethod": "GET",
"response": {
"$ref": "SearchGroupsResponse"
},
"parameterOrder": [],
"parameters": {
"pageToken": {
"location": "query",
"description": "The next_page_token value returned from a previous search request, if any.",
"type": "string"
},
"pageSize": {
"location": "query",
"description": "The default page size is 200 (max 1000) for the BASIC view, and 50\n(max 500) for the FULL view.",
"format": "int32",
"type": "integer"
},
"query": {
"location": "query",
"description": "`Required`. Query string for performing search on groups. Users can search\non parent and label attributes of groups.\nEXACT match ('==') is supported on parent, and CONTAINS match ('in') is\nsupported on labels.",
"type": "string"
},
"view": {
"location": "query",
"enum": [
"VIEW_UNSPECIFIED",
"BASIC",
"FULL"
],
"description": "Group resource view to be returned. Defaults to [View.BASIC]().",
"type": "string"
}
},
"flatPath": "v1/groups:search",
"id": "cloudidentity.groups.search",
"path": "v1/groups:search",
"description": "Searches for Groups."
},
"get": {
"id": "cloudidentity.groups.get",
"path": "v1/{+name}",
"description": "Retrieves a Group.",
"httpMethod": "GET",
"response": {
"$ref": "Group"
},
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup in the format: `groups/{group_id}`, where `group_id` is the unique ID\nassigned to the Group.",
"required": true,
"type": "string",
"pattern": "^groups/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/groups/{groupsId}"
},
"patch": {
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
"httpMethod": "PATCH",
"parameters": {
"name": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup in the format: `groups/{group_id}`, where group_id is the unique ID\nassigned to the Group.\n\nMust be left blank while creating a Group.",
"required": true,
"type": "string",
"pattern": "^groups/[^/]+$",
"location": "path"
},
"updateMask": {
"location": "query",
"description": "Editable fields: `display_name`, `description`",
"format": "google-fieldmask",
"type": "string"
}
},
"flatPath": "v1/groups/{groupsId}",
"path": "v1/{+name}",
"id": "cloudidentity.groups.patch",
"request": {
"$ref": "Group"
},
"description": "Updates a Group."
},
"delete": {
"httpMethod": "DELETE",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"pattern": "^groups/[^/]+$",
"location": "path",
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup in the format: `groups/{group_id}`, where `group_id` is the unique ID\nassigned to the Group.",
"required": true,
"type": "string"
}
},
"flatPath": "v1/groups/{groupsId}",
"id": "cloudidentity.groups.delete",
"path": "v1/{+name}",
"description": "Deletes a Group."
},
"list": {
"response": {
"$ref": "ListGroupsResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {
"parent": {
"location": "query",
"description": "`Required`. May be made Optional in the future.\nCustomer ID to list all groups from.",
"type": "string"
},
"pageToken": {
"location": "query",
"description": "The next_page_token value returned from a previous list request, if any.",
"type": "string"
},
"pageSize": {
"location": "query",
"description": "The default page size is 200 (max 1000) for the BASIC view, and 50\n(max 500) for the FULL view.",
"format": "int32",
"type": "integer"
},
"view": {
"enum": [
"VIEW_UNSPECIFIED",
"BASIC",
"FULL"
],
"description": "Group resource view to be returned. Defaults to [View.BASIC]().",
"type": "string",
"location": "query"
}
},
"flatPath": "v1/groups",
"path": "v1/groups",
"id": "cloudidentity.groups.list",
"description": "List groups within a customer or a domain."
}
}
}
},
"parameters": {
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
"default": "true",
"location": "query"
},
"quotaUser": {
"location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
},
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
"$.xgafv": {
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
"type": "string"
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
},
"callback": {
"location": "query",
"description": "JSONP",
"type": "string"
},
"alt": {
"description": "Data format for response.",
"default": "json",
"enum": [
"json",
"media",
"proto"
],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
"location": "query"
},
"access_token": {
"location": "query",
"description": "OAuth access token.",
"type": "string"
}
},
"version": "v1",
"baseUrl": "https://cloudidentity.googleapis.com/",
"kind": "discovery#restDescription",
"description": "API for provisioning and managing identity resources.",
"servicePath": "",
"basePath": "",
"revision": "20190219",
"documentationLink": "https://cloud.google.com/identity/",
"id": "cloudidentity:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
}
},
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
}
},
"id": "Status"
},
"ListMembershipsResponse": {
"properties": {
"memberships": {
"description": "List of Memberships.",
"type": "array",
"items": {
"$ref": "Membership"
}
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results available for listing.",
"type": "string"
}
},
"id": "ListMembershipsResponse",
"type": "object"
},
"ListGroupsResponse": {
"properties": {
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results available for listing.",
"type": "string"
},
"groups": {
"description": "Groups returned in response to list request.\nThe results are not sorted.",
"type": "array",
"items": {
"$ref": "Group"
}
}
},
"id": "ListGroupsResponse",
"description": "Response message for ListGroups operation.",
"type": "object"
},
"Membership": {
"description": "Resource representing a Membership within a Group",
"type": "object",
"properties": {
"updateTime": {
"description": "Last updated timestamp of the Membership. Output only.",
"format": "google-datetime",
"type": "string"
},
"roles": {
"description": "Roles for a member within the Group.\n\nCurrently supported MembershipRoles: `\"MEMBER\"`.",
"type": "array",
"items": {
"$ref": "MembershipRole"
}
},
"name": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nMembership in the format: `groups/{group_id}/memberships/{member_id}`, where\ngroup_id is the unique ID assigned to the Group to which Membership belongs\nto, and member_id is the unique ID assigned to the member\n\nMust be left blank while creating a Membership.",
"type": "string"
},
"preferredMemberKey": {
"$ref": "EntityKey",
"description": "EntityKey of the entity to be added as the member. Must be set while\ncreating a Membership, read-only afterwards.\n\nCurrently allowed entity types: `Users`, `Groups`."
},
"createTime": {
"description": "Creation timestamp of the Membership. Output only.",
"format": "google-datetime",
"type": "string"
}
},
"id": "Membership"
},
"Group": {
"description": "Resource representing a Group.",
"type": "object",
"properties": {
"parent": {
"description": "The entity under which this Group resides in Cloud Identity resource\nhierarchy. Must be set when creating a Group, read-only afterwards.\n\nCurrently allowed types: `identitysources`.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "`Required`. Labels for Group resource.\nFor creating Groups under a namespace, set label key to\n'labels/system/groups/external' and label value as empty.",
"type": "object"
},
"createTime": {
"description": "The time when the Group was created.\nOutput only.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "The time when the Group was last updated.\nOutput only.",
"format": "google-datetime",
"type": "string"
},
"name": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup in the format: `groups/{group_id}`, where group_id is the unique ID\nassigned to the Group.\n\nMust be left blank while creating a Group.",
"type": "string"
},
"groupKey": {
"$ref": "EntityKey",
"description": "EntityKey of the Group.\n\nMust be set when creating a Group, read-only afterwards."
},
"displayName": {
"description": "The Group's display name.",
"type": "string"
},
"description": {
"description": "An extended description to help users determine the purpose of a Group. For\nexample, you can include information about who should join the Group, the\ntypes of messages to send to the Group, links to FAQs about the Group, or\nrelated Groups. Maximum length is 4,096 characters.",
"type": "string"
}
},
"id": "Group"
},
"Operation": {
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
"type": "boolean"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
"type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
"type": "string"
},
"error": {
"description": "The error result of the operation in case of failure or cancellation.",
"$ref": "Status"
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
"type": "object"
}
},
"id": "Operation",
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object"
},
"LookupMembershipNameResponse": {
"type": "object",
"properties": {
"name": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nMembership being looked up.\n\nFormat: `groups/{group_id}/memberships/{member_id}`, where `group_id` is\nthe unique ID assigned to the Group to which Membership belongs to, and\n`member_id` is the unique ID assigned to the member.",
"type": "string"
}
},
"id": "LookupMembershipNameResponse"
},
"MembershipRole": {
"properties": {
"name": {
"description": "MembershipRole in string format.\n\nCurrently supported MembershipRoles: `\"MEMBER\"`.",
"type": "string"
}
},
"id": "MembershipRole",
"description": "Resource representing a role within a Membership.",
"type": "object"
},
"SearchGroupsResponse": {
"properties": {
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results available for specified query.",
"type": "string"
},
"groups": {
"description": "List of Groups satisfying the search query.",
"type": "array",
"items": {
"$ref": "Group"
}
}
},
"id": "SearchGroupsResponse",
"type": "object"
},
"EntityKey": {
"description": "An EntityKey uniquely identifies an Entity. Namespaces are used to provide\nisolation for IDs. A single ID can be reused across namespaces but the\ncombination of a namespace and an ID must be unique.",
"type": "object",
"properties": {
"id": {
"description": "The ID of the entity within the given namespace. The ID must be unique\nwithin its namespace.",
"type": "string"
},
"namespace": {
"description": "Namespaces provide isolation for IDs, so an ID only needs to be unique\nwithin its namespace.\n\nNamespaces are currently only created as part of IdentitySource creation\nfrom Admin Console. A namespace `\"identitysources/{identity_source_id}\"` is\ncreated corresponding to every Identity Source `identity_source_id`.",
"type": "string"
}
},
"id": "EntityKey"
},
"LookupGroupNameResponse": {
"properties": {
"name": {
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup in the format: `groups/{group_id}`, where `group_id` is the unique ID\nassigned to the Group.",
"type": "string"
}
},
"id": "LookupGroupNameResponse",
"type": "object"
}
},
"protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"canonicalName": "Cloud Identity",
"rootUrl": "https://cloudidentity.googleapis.com/",
"ownerDomain": "google.com",
"name": "cloudidentity",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Cloud Identity API"
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy