OAUTH Application API, gRPC: ApplicationService.Get
Returns the specified OAuth application resource.
To get the list of available OAuth applications, make a List request.
gRPC request
rpc Get (GetApplicationRequest) returns (Application)
GetApplicationRequest
{
"application_id": "string"
}
Request to get a OAuth application.
|
Field |
Description |
|
application_id |
string Required field. ID of the OAuth application to return. The maximum string length in characters is 50. |
Application
{
"id": "string",
"name": "string",
"organization_id": "string",
"description": "string",
"group_claims_settings": {
"group_distribution_type": "GroupDistributionType"
},
"client_grant": {
"client_id": "string",
"authorized_scopes": [
"string"
]
},
"status": "Status",
"labels": "map<string, string>",
"created_at": "google.protobuf.Timestamp",
"updated_at": "google.protobuf.Timestamp"
}
An OAuth application resource.
|
Field |
Description |
|
id |
string ID of the application. |
|
name |
string Name of the application. |
|
organization_id |
string ID of the organization that the application belongs to. |
|
description |
string Description of the application. 0-256 characters long. |
|
group_claims_settings |
Settings of the group claims |
|
client_grant |
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 |
|
created_at |
Creation timestamp. |
|
updated_at |
Modification timestamp. |
GroupClaimsSettings
Settings of the group claims
|
Field |
Description |
|
group_distribution_type |
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 |
|
client_id |
string Required field. OAuth client id The maximum string length in characters is 50. |
|
authorized_scopes[] |
string List of authorized client scopes by the application The maximum string length in characters for each value is 255. Each value must match the regular expression |