Skip to main content

Get OAuth Client

GET 

https://sailpoint.api.identitynow.com/v2024/oauth-clients/:id

This gets details of an OAuth client.

Request

Path Parameters

    id stringrequired

    The OAuth client id

    Example: ef38f94347e94562b5bb8424a56397d8

Responses

Request succeeded.

Schema
    idstringrequired

    ID of the OAuth client

    Example: 2c9180835d2e5168015d32f890ca1581
    businessNamestringnullablerequired

    The name of the business the API Client should belong to

    Example: Acme-Solar
    homepageUrlstringnullablerequired

    The homepage URL associated with the owner of the API Client

    Example: http://localhost:12345
    namestringrequired

    A human-readable name for the API Client

    Example: Demo API Client
    descriptionstringnullablerequired

    A description of the API Client

    Example: An API client used for the authorization_code, refresh_token, and client_credentials flows
    accessTokenValiditySecondsint32required

    The number of seconds an access token generated for this API Client is valid for

    Example: 750
    refreshTokenValiditySecondsint32required

    The number of seconds a refresh token generated for this API Client is valid for

    Example: 86400
    redirectUrisstring[]nullablerequired

    A list of the approved redirect URIs used with the authorization_code flow

    Example: ["http://localhost:12345"]
    grantTypesstring[]required

    A list of OAuth 2.0 grant types this API Client can be used with

    Possible values: [CLIENT_CREDENTIALS, AUTHORIZATION_CODE, REFRESH_TOKEN]

    Example: ["AUTHORIZATION_CODE","CLIENT_CREDENTIALS","REFRESH_TOKEN"]
    accessTypestringrequired

    Access type of API Client indicating online or offline use

    Possible values: [ONLINE, OFFLINE]

    Example: OFFLINE
    typestringrequired

    Type of an API Client indicating public or confidentials use

    Possible values: [CONFIDENTIAL, PUBLIC]

    Example: CONFIDENTIAL
    internalbooleanrequired

    An indicator of whether the API Client can be used for requests internal to IDN

    Example: false
    enabledbooleanrequired

    An indicator of whether the API Client is enabled for use

    Example: true
    strongAuthSupportedbooleanrequired

    An indicator of whether the API Client supports strong authentication

    Example: false
    claimsSupportedbooleanrequired

    An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow

    Example: false
    createddate-timerequired

    The date and time, down to the millisecond, when the API Client was created

    Example: 2017-07-11T18:45:37.098Z
    modifieddate-timerequired

    The date and time, down to the millisecond, when the API Client was last updated

    Example: 2018-06-25T20:22:28.104Z
    secretstringnullable
    metadatastringnullable
    lastUseddate-timenullable

    The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed.

    Example: 2017-07-11T18:45:37.098Z
    scopestring[]nullablerequired

    Scopes of the API Client.

    Example: ["demo:api-client-scope:first","demo:api-client-scope:second"]

Authorization: oauth2

type: Personal Access Token
scopes: sp:oauth-client:manage, sp:oauth-client:read
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://sailpoint.api.identitynow.com/v2024/oauth-clients/:id"
method := "GET"

client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)

if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Bearer <TOKEN>")

res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()

body, err := io.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
Request Collapse all
Base URL
https://sailpoint.api.identitynow.com/v2024
Auth
Parameters
— pathrequired
ResponseClear

Click the Send API Request button above and see the response here!