OAUTH Application API, REST: Application.Update

Статья создана

Обновлена 3 октября 2025 г.

HTTP request
Path parameters
Body parameters
GroupClaimsSettings
ClientGrant
Response
UpdateApplicationMetadata
Status
Application
GroupClaimsSettings
ClientGrant

Updates the specified OAuth application.

HTTP request

PATCH https://organization-manager.api.cloud.yandex.net/organization-manager/v1/idp/application/oauth/applications/{applicationId}

Path parameters

Request to update a OAuth application.

Field

Description

applicationId

string

Required field. ID of the OAuth application to update.
To get the OAuth application ID, make a ApplicationService.List request.

Body parameters

{
  "updateMask": "string",
  "name": "string",
  "description": "string",
  "groupClaimsSettings": {
    "groupDistributionType": "string"
  },
  "clientGrant": {
    "clientId": "string",
    "authorizedScopes": [
      "string"
    ]
  },
  "labels": "object"
}

Request to update a OAuth application.

Field	Description
updateMask	string (field-mask) A comma-separated names off ALL fields to be updated. Only the specified fields will be changed. The others will be left untouched. If the field is specified in `updateMask` and no value for that field was sent in the request, the field's value will be reset to the default. The default value for most fields is null or 0. If `updateMask` is not sent in the request, all fields' values will be updated. Fields specified in the request will be updated to provided values. The rest of the fields will be reset to the default.
name	string Name of the OAuth application. The name must be unique within the organization.
description	string Description of the OAuth application.
groupClaimsSettings	GroupClaimsSettings Settings of the group claims
clientGrant	ClientGrant Connection to the OAuth client with specified scopes
labels	object (map<string, string>) Resource labels as key:value pairs.

GroupClaimsSettings

Settings of the group claims

Field

Description

groupDistributionType

enum (GroupDistributionType)

Represents current distribution type of the groups. I.e. which groups are visible for the application users.

GROUP_DISTRIBUTION_TYPE_UNSPECIFIED: The distribution type is unspecified
NONE: No groups are visible for the application users
ASSIGNED_GROUPS: Only assigned groups are visible for the application users
ALL_GROUPS: All groups are visible for the application users

ClientGrant

Represents connection to the OAuth client with specified scopes

Field

Description

clientId

string

Required field. OAuth client id

authorizedScopes[]

string

List of authorized client scopes by the application

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "applicationId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "name": "string",
    "organizationId": "string",
    "description": "string",
    "groupClaimsSettings": {
      "groupDistributionType": "string"
    },
    "clientGrant": {
      "clientId": "string",
      "authorizedScopes": [
        "string"
      ]
    },
    "status": "string",
    "labels": "object",
    "createdAt": "string",
    "updatedAt": "string"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
done	boolean 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.
metadata	UpdateApplicationMetadata Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	Application 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 the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

UpdateApplicationMetadata

Metadata for the ApplicationService.Update operation.

Field

Description

applicationId

string

ID of the OAuth application that is being updated.

Status

The error result of the operation in case of failure or cancellation.

Field	Description
code	integer (int32) Error code. An enum value of google.rpc.Code.
message	string An error message.
details[]	object A list of messages that carry the error details.

Application

An OAuth application resource.

Field	Description
id	string ID of the application.
name	string Name of the application. The name is unique within the organization. 3-63 characters long.
organizationId	string ID of the organization that the application belongs to.
description	string Description of the application. 0-256 characters long.
groupClaimsSettings	GroupClaimsSettings Settings of the group claims
clientGrant	ClientGrant Represents current connection to the OAuth client with specified scopes
status	enum (Status) Current status of the application. `STATUS_UNSPECIFIED`: The status is not specified. `CREATING`: The apllication is in the process of being created. `ACTIVE`: The apllication is active and operational. `SUSPENDED`: The apllication is suspended. I.e. authentication via this application is disabled. `DELETING`: The apllication is in the process of being deleted.
labels	object (map<string, string>) Resource labels as `key:value` pairs.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
updatedAt	string (date-time) Modification timestamp. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

GroupClaimsSettings

Settings of the group claims

Field

Description

groupDistributionType

enum (GroupDistributionType)

Represents current distribution type of the groups. I.e. which groups are visible for the application users.

GROUP_DISTRIBUTION_TYPE_UNSPECIFIED: The distribution type is unspecified
NONE: No groups are visible for the application users
ASSIGNED_GROUPS: Only assigned groups are visible for the application users
ALL_GROUPS: All groups are visible for the application users

ClientGrant

Represents connection to the OAuth client with specified scopes

Field

Description

clientId

string

Required field. OAuth client id

authorizedScopes[]

string

List of authorized client scopes by the application

OAUTH Application API, REST: Application.Update

HTTP requestHTTP request

Path parametersPath parameters

Body parametersBody parameters

GroupClaimsSettingsGroupClaimsSettings

ClientGrantClientGrant

ResponseResponse

UpdateApplicationMetadataUpdateApplicationMetadata

StatusStatus

ApplicationApplication

GroupClaimsSettingsGroupClaimsSettings

ClientGrantClientGrant

Была ли статья полезна?

HTTP request

Path parameters

Body parameters

GroupClaimsSettings

ClientGrant

Response

UpdateApplicationMetadata

Status

Application

GroupClaimsSettings

ClientGrant