411f9f98c01e
Returns the specified auth client.
You need one of the global.auth_clients.get, tenants.auth_clients.get, contracts.auth_clients.get or workspaces.auth_clients.get permission to access this resource. Each permission allows to get auth client in particular scope inclusively: global.auth_clients.get allows to get global client, tenants.auth_clients.get allows to get global and tenant’s clients, contracts.auth_clients.get allows to get global, tenant’s and all tenant’s contracts clients, workspaces.auth_clients.get allows to get global, tenant’s, contracts’ and workspaces’ clients. auth_clients.get permissions are also used to authorize access to auth client’s credentials field: one can see auth client’s credential only if client’s scope and permission’s scope match, i.e. credentials of tenant’s auth client are visible for users only with tenants.auth_clients.get permissions, though tenant auth client itself is visible for users with workspaces.auth_clients.get. To specify scope of request one of workspace_id, contract_id or tenant_id query parameters is used. For example, tenant auth client can be retrieved by id if user has workspaces.auth_clients.get permission in one of the tenant’s workspaces, so to specify those workspace workspace_id query parameter is used, without scope parameter you can get only global client. In case if the user tries to get not a global client and doesn’t specify the query parameter - such request will be rejected, as permission can’t be checked.
Path parameters
Auth client identifier
Query parameters
Show auth clients available in the given workpspace (including contract’s, tenant’s and global auth-clients). Only one of workspace_id, contract_id, tenant_id can be specified at time. If none these of parameters is specified only global clients will be returned.
Show Auth Clients available in the given contract (including tenant’s and global auth-clients).
Show Auth Clients available in the given tenant and global scope.
Response
OK
Example response
{
"data": {
"id": "5b4f337bff4304610483ba67",
"links": {
"self": "/v2/auth-clients/5b4f337bff4304610483ba67"
},
"attributes": {
"name": "Auth client name",
"credentials": {
"client_id": "327193566714-99k85u8op9i10upjf8raus0aqjmtj.apps.googleusercontent.com",
"client_secret": "wryIpa3vltT4GttJOQSKo3eo",
"refresh_token_uri": "https://www.googleapis.com/oauth2/v4/token",
"token_uri": "https://www.googleapis.com/oauth2/v4/token",
"auth_uri": "https://www.googleapis.com/oauth2/v2/auth"
}
},
"relationships": {
"components": {
"data": [
{
"id": "5b4f337bff4304610483ba67"
}
]
},
"workspace": {
"data": {
"id": "5b4f337bff4304610483ba67"
},
"links": {
"self": "/v2/workspaces/5b4f337bff4304610483ba67"
}
}
}
}
}