Skip to content

Commit

Permalink
fix(iam): update the API
Browse files Browse the repository at this point in the history
#### iam:v1
The following keys were changed:
- resources.projects.resources.serviceAccounts.methods.signBlob.description
- resources.projects.resources.serviceAccounts.methods.signBlob.parameters.name.description
- resources.projects.resources.serviceAccounts.methods.signJwt.description
- resources.projects.resources.serviceAccounts.methods.signJwt.parameters.name.description
- schemas.SignBlobRequest.description
- schemas.SignBlobRequest.properties.bytesToSign.description
- schemas.SignBlobResponse.description
- schemas.SignBlobResponse.properties.keyId.description
- schemas.SignBlobResponse.properties.signature.description
- schemas.SignJwtRequest.description
- schemas.SignJwtRequest.properties.payload.description
- schemas.SignJwtResponse.description
- schemas.SignJwtResponse.properties.keyId.description
- schemas.SignJwtResponse.properties.signedJwt.description
  • Loading branch information
yoshi-automation authored and JustinBeckwith committed Jul 17, 2020
1 parent f8670e9 commit ca62f87
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 33 deletions.
30 changes: 15 additions & 15 deletions discovery/iam-v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -833,7 +833,7 @@
]
},
"signBlob": {
"description": "**Note:** We are in the process of deprecating this method. Use the\n[`signBlob`](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signBlob)\nmethod in the IAM Service Account Credentials API instead.\n\nSigns a blob using the system-managed private key for a ServiceAccount.",
"description": "**Note:** This method is deprecated and will stop working on July 1, 2021.\nUse the\n[`signBlob`](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signBlob)\nmethod in the IAM Service Account Credentials API instead. If you currently\nuse this method, see the [migration\nguide](https://cloud.google.com/iam/help/credentials/migrate-api) for\ninstructions.\n\nSigns a blob using the system-managed private key for a ServiceAccount.",
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signBlob",
"httpMethod": "POST",
"id": "iam.projects.serviceAccounts.signBlob",
Expand All @@ -842,7 +842,7 @@
],
"parameters": {
"name": {
"description": "Required. The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
"description": "Required. Deprecated. [Migrate to Service Account Credentials\nAPI](https://cloud.google.com/iam/help/credentials/migrate-api).\n\nThe resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
"location": "path",
"pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
"required": true,
Expand All @@ -861,7 +861,7 @@
]
},
"signJwt": {
"description": "**Note:** We are in the process of deprecating this method. Use the\n[`signJwt`](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signJwt)\nmethod in the IAM Service Account Credentials API instead.\n\nSigns a JSON Web Token (JWT) using the system-managed private key for a\nServiceAccount.",
"description": "**Note:** This method is deprecated and will stop working on July 1, 2021.\nUse the\n[`signJwt`](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signJwt)\nmethod in the IAM Service Account Credentials API instead. If you currently\nuse this method, see the [migration\nguide](https://cloud.google.com/iam/help/credentials/migrate-api) for\ninstructions.\n\nSigns a JSON Web Token (JWT) using the system-managed private key for a\nServiceAccount.",
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signJwt",
"httpMethod": "POST",
"id": "iam.projects.serviceAccounts.signJwt",
Expand All @@ -870,7 +870,7 @@
],
"parameters": {
"name": {
"description": "Required. The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
"description": "Required. Deprecated. [Migrate to Service Account Credentials\nAPI](https://cloud.google.com/iam/help/credentials/migrate-api).\n\nThe resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
"location": "path",
"pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
"required": true,
Expand Down Expand Up @@ -1228,7 +1228,7 @@
}
}
},
"revision": "20200617",
"revision": "20200709",
"rootUrl": "https://iam.googleapis.com/",
"schemas": {
"AdminAuditData": {
Expand Down Expand Up @@ -2063,54 +2063,54 @@
"type": "object"
},
"SignBlobRequest": {
"description": "The service account sign blob request.",
"description": "Deprecated. [Migrate to Service Account Credentials\nAPI](https://cloud.google.com/iam/help/credentials/migrate-api).\n\nThe service account sign blob request.",
"id": "SignBlobRequest",
"properties": {
"bytesToSign": {
"description": "Required. The bytes to sign.",
"description": "Required. Deprecated. [Migrate to Service Account Credentials\nAPI](https://cloud.google.com/iam/help/credentials/migrate-api).\n\nThe bytes to sign.",
"format": "byte",
"type": "string"
}
},
"type": "object"
},
"SignBlobResponse": {
"description": "The service account sign blob response.",
"description": "Deprecated. [Migrate to Service Account Credentials\nAPI](https://cloud.google.com/iam/help/credentials/migrate-api).\n\nThe service account sign blob response.",
"id": "SignBlobResponse",
"properties": {
"keyId": {
"description": "The id of the key used to sign the blob.",
"description": "Deprecated. [Migrate to Service Account Credentials\nAPI](https://cloud.google.com/iam/help/credentials/migrate-api).\n\nThe id of the key used to sign the blob.",
"type": "string"
},
"signature": {
"description": "The signed blob.",
"description": "Deprecated. [Migrate to Service Account Credentials\nAPI](https://cloud.google.com/iam/help/credentials/migrate-api).\n\nThe signed blob.",
"format": "byte",
"type": "string"
}
},
"type": "object"
},
"SignJwtRequest": {
"description": "The service account sign JWT request.",
"description": "Deprecated. [Migrate to Service Account Credentials\nAPI](https://cloud.google.com/iam/help/credentials/migrate-api).\n\nThe service account sign JWT request.",
"id": "SignJwtRequest",
"properties": {
"payload": {
"description": "Required. The JWT payload to sign. Must be a serialized JSON object that contains a\nJWT Claims Set. For example: `{\"sub\": \"user@example.com\", \"iat\": 313435}`\n\nIf the JWT Claims Set contains an expiration time (`exp`) claim, it must be\nan integer timestamp that is not in the past and no more than 1 hour in the\nfuture.\n\nIf the JWT Claims Set does not contain an expiration time (`exp`) claim,\nthis claim is added automatically, with a timestamp that is 1 hour in the\nfuture.",
"description": "Required. Deprecated. [Migrate to Service Account Credentials\nAPI](https://cloud.google.com/iam/help/credentials/migrate-api).\n\nThe JWT payload to sign. Must be a serialized JSON object that contains a\nJWT Claims Set. For example: `{\"sub\": \"user@example.com\", \"iat\": 313435}`\n\nIf the JWT Claims Set contains an expiration time (`exp`) claim, it must be\nan integer timestamp that is not in the past and no more than 1 hour in the\nfuture.\n\nIf the JWT Claims Set does not contain an expiration time (`exp`) claim,\nthis claim is added automatically, with a timestamp that is 1 hour in the\nfuture.",
"type": "string"
}
},
"type": "object"
},
"SignJwtResponse": {
"description": "The service account sign JWT response.",
"description": "Deprecated. [Migrate to Service Account Credentials\nAPI](https://cloud.google.com/iam/help/credentials/migrate-api).\n\nThe service account sign JWT response.",
"id": "SignJwtResponse",
"properties": {
"keyId": {
"description": "The id of the key used to sign the JWT.",
"description": "Deprecated. [Migrate to Service Account Credentials\nAPI](https://cloud.google.com/iam/help/credentials/migrate-api).\n\nThe id of the key used to sign the JWT.",
"type": "string"
},
"signedJwt": {
"description": "The signed JWT.",
"description": "Deprecated. [Migrate to Service Account Credentials\nAPI](https://cloud.google.com/iam/help/credentials/migrate-api).\n\nThe signed JWT.",
"type": "string"
}
},
Expand Down
42 changes: 24 additions & 18 deletions src/apis/iam/v1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -676,46 +676,46 @@ export namespace iam_v1 {
updateMask?: string | null;
}
/**
* The service account sign blob request.
* Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The service account sign blob request.
*/
export interface Schema$SignBlobRequest {
/**
* Required. The bytes to sign.
* Required. Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The bytes to sign.
*/
bytesToSign?: string | null;
}
/**
* The service account sign blob response.
* Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The service account sign blob response.
*/
export interface Schema$SignBlobResponse {
/**
* The id of the key used to sign the blob.
* Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The id of the key used to sign the blob.
*/
keyId?: string | null;
/**
* The signed blob.
* Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The signed blob.
*/
signature?: string | null;
}
/**
* The service account sign JWT request.
* Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The service account sign JWT request.
*/
export interface Schema$SignJwtRequest {
/**
* Required. The JWT payload to sign. Must be a serialized JSON object that contains a JWT Claims Set. For example: `{"sub": "user@example.com", "iat": 313435}` If the JWT Claims Set contains an expiration time (`exp`) claim, it must be an integer timestamp that is not in the past and no more than 1 hour in the future. If the JWT Claims Set does not contain an expiration time (`exp`) claim, this claim is added automatically, with a timestamp that is 1 hour in the future.
* Required. Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The JWT payload to sign. Must be a serialized JSON object that contains a JWT Claims Set. For example: `{"sub": "user@example.com", "iat": 313435}` If the JWT Claims Set contains an expiration time (`exp`) claim, it must be an integer timestamp that is not in the past and no more than 1 hour in the future. If the JWT Claims Set does not contain an expiration time (`exp`) claim, this claim is added automatically, with a timestamp that is 1 hour in the future.
*/
payload?: string | null;
}
/**
* The service account sign JWT response.
* Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The service account sign JWT response.
*/
export interface Schema$SignJwtResponse {
/**
* The id of the key used to sign the JWT.
* Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The id of the key used to sign the JWT.
*/
keyId?: string | null;
/**
* The signed JWT.
* Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The signed JWT.
*/
signedJwt?: string | null;
}
Expand Down Expand Up @@ -4745,7 +4745,7 @@ export namespace iam_v1 {

/**
* iam.projects.serviceAccounts.signBlob
* @desc **Note:** We are in the process of deprecating this method. Use the [`signBlob`](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signBlob) method in the IAM Service Account Credentials API instead. Signs a blob using the system-managed private key for a ServiceAccount.
* @desc **Note:** This method is deprecated and will stop working on July 1, 2021. Use the [`signBlob`](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signBlob) method in the IAM Service Account Credentials API instead. If you currently use this method, see the [migration guide](https://cloud.google.com/iam/help/credentials/migrate-api) for instructions. Signs a blob using the system-managed private key for a ServiceAccount.
* @example
* // Before running the sample:
* // - Enable the API at:
Expand All @@ -4770,7 +4770,10 @@ export namespace iam_v1 {
*
* // Do the magic
* const res = await iam.projects.serviceAccounts.signBlob({
* // Required. The resource name of the service account in the following format:
* // Required. Deprecated. [Migrate to Service Account Credentials
* // API](https://cloud.google.com/iam/help/credentials/migrate-api).
* //
* // The resource name of the service account in the following format:
* // `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
* // Using `-` as a wildcard for the `PROJECT_ID` will infer the project from
* // the account. The `ACCOUNT` value can be the `email` address or the
Expand Down Expand Up @@ -4803,7 +4806,7 @@ export namespace iam_v1 {
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account.
* @param {string} params.name Required. Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account.
* @param {().SignBlobRequest} params.requestBody Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
Expand Down Expand Up @@ -4890,7 +4893,7 @@ export namespace iam_v1 {

/**
* iam.projects.serviceAccounts.signJwt
* @desc **Note:** We are in the process of deprecating this method. Use the [`signJwt`](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signJwt) method in the IAM Service Account Credentials API instead. Signs a JSON Web Token (JWT) using the system-managed private key for a ServiceAccount.
* @desc **Note:** This method is deprecated and will stop working on July 1, 2021. Use the [`signJwt`](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signJwt) method in the IAM Service Account Credentials API instead. If you currently use this method, see the [migration guide](https://cloud.google.com/iam/help/credentials/migrate-api) for instructions. Signs a JSON Web Token (JWT) using the system-managed private key for a ServiceAccount.
* @example
* // Before running the sample:
* // - Enable the API at:
Expand All @@ -4915,7 +4918,10 @@ export namespace iam_v1 {
*
* // Do the magic
* const res = await iam.projects.serviceAccounts.signJwt({
* // Required. The resource name of the service account in the following format:
* // Required. Deprecated. [Migrate to Service Account Credentials
* // API](https://cloud.google.com/iam/help/credentials/migrate-api).
* //
* // The resource name of the service account in the following format:
* // `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
* // Using `-` as a wildcard for the `PROJECT_ID` will infer the project from
* // the account. The `ACCOUNT` value can be the `email` address or the
Expand Down Expand Up @@ -4948,7 +4954,7 @@ export namespace iam_v1 {
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account.
* @param {string} params.name Required. Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account.
* @param {().SignJwtRequest} params.requestBody Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
Expand Down Expand Up @@ -5606,7 +5612,7 @@ export namespace iam_v1 {
export interface Params$Resource$Projects$Serviceaccounts$Signblob
extends StandardParameters {
/**
* Required. The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account.
* Required. Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account.
*/
name?: string;

Expand All @@ -5618,7 +5624,7 @@ export namespace iam_v1 {
export interface Params$Resource$Projects$Serviceaccounts$Signjwt
extends StandardParameters {
/**
* Required. The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account.
* Required. Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account.
*/
name?: string;

Expand Down

0 comments on commit ca62f87

Please # to comment.