OAUTH Application API, REST: Application.Get
Returns the specified OAuth application resource.
To get the list of available OAuth applications, make a List request.
HTTP request
GET https://organization-manager.api.yandexcloud.kz/organization-manager/v1/idp/application/oauth/applications/{applicationId}
Path parameters
Request to get a OAuth application.
|
Field |
Description |
|
applicationId |
string Required field. ID of the OAuth application to return. |
Response
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. |
|
organizationId |
string ID of the organization that the application belongs to. |
|
description |
string Description of the application. 0-256 characters long. |
|
groupClaimsSettings |
Settings of the group claims |
|
clientGrant |
Represents current connection to the OAuth client with specified scopes |
|
status |
enum (Status) Current status of the application.
|
|
labels |
object (map<string, string>) Resource labels as |
|
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
|
updatedAt |
string (date-time) Modification timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
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.
|
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 |