Yandex Cloud
Search
Contact UsGet started
  • Pricing
  • Customer Stories
  • Documentation
  • Blog
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • AI for business
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Center for Technologies and Society
    • Yandex Cloud Partner program
  • Pricing
  • Customer Stories
  • Documentation
  • Blog
© 2025 Direct Cursus Technology L.L.C.
Yandex Identity Hub
  • Access management
  • Pricing policy
  • Terraform reference
    • Authentication
      • Overview
        • Overview
          • Overview
            • Overview
            • Get
            • List
            • Create
            • Update
            • Suspend
            • Reactivate
            • Delete
            • ListOperations
            • ListAccessBindings
            • SetAccessBindings
            • UpdateAccessBindings
            • ListAssignments
            • UpdateAssignments
  • Audit Trails events
  • Release notes

In this article:

  • HTTP request
  • Path parameters
  • Response
  • GroupClaimsSettings
  • ClientGrant
  1. API reference
  2. REST
  3. Identity Provider API
  4. OAUTH Application API
  5. Application
  6. Get

OAUTH Application API, REST: Application.Get

Written by
Yandex Cloud
Updated at October 3, 2025
  • HTTP request
  • Path parameters
  • Response
  • GroupClaimsSettings
  • ClientGrant

Returns the specified OAuth application resource.

To get the list of available OAuth applications, make a List request.

HTTP requestHTTP request

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

Path parametersPath parameters

Request to get a OAuth application.

Field

Description

applicationId

string

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

ResponseResponse

HTTP Code: 200 - OK

{
  "id": "string",
  "name": "string",
  "organizationId": "string",
  "description": "string",
  "groupClaimsSettings": {
    "groupDistributionType": "string"
  },
  "clientGrant": {
    "clientId": "string",
    "authorizedScopes": [
      "string"
    ]
  },
  "status": "string",
  "labels": "object",
  "createdAt": "string",
  "updatedAt": "string"
}

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).

GroupClaimsSettingsGroupClaimsSettings

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

ClientGrantClientGrant

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

Was the article helpful?

Previous
Overview
Next
List
© 2025 Direct Cursus Technology L.L.C.