Interface OAuthClientConfiguration

OAuth client information.

Hierarchy

  • OAuthClientConfiguration

Properties

accessTokenTimeToLive audiences audiencesAsString claims clientId clientName delegationTimeToLive description id idTokenIssuer idTokenTimeToLive initiallyAuthenticatedUser name prefixScopes properties redirectUris refreshTokenTimeToLive scope scopeMap scopeNames scopes secret

Methods

allowConsentDeselection getAccessTokenTimeToLive getAudiences getAudiencesAsString getClaims getClientId getClientName getDelegationTimeToLive getDescription getId getIdTokenIssuer getIdTokenTimeToLive getInitiallyAuthenticatedUser getName getPrefixScopes getProperties getRedirectUris getRefreshTokenTimeToLive getScope getScopeMap getScopeNames getScopes getSecret isPublic requiresConsent requiresUserConsent

Properties

accessTokenTimeToLive

accessTokenTimeToLive: number

Returns

the number of seconds that a new access token is valid for.

audiences

audiences: any[]

Returns

the audiences of this OAuth client.

audiencesAsString

audiencesAsString: string

Returns

the whitespace-separated audiences of this OAuth client.

claims

claims: {
    [key: string]: RequestedClaim;
}

Returns

a map containing all claims that this OAuth client is allowed to request for tokens.

Type declaration

clientId

clientId: string

Deprecated

use getId() instead.

clientName

clientName: null | string

Deprecated

use getName() instead.

delegationTimeToLive

delegationTimeToLive: number

Returns

the number of seconds that a new delegation is valid for.

description

description: null | string

A description of this OAuth client.

id

id: string

The ID of the OAuth client as configured in Curity.

idTokenIssuer

idTokenIssuer: null | string

Returns

the ID token issuer if configured for this client, or null otherwise.

idTokenTimeToLive

idTokenTimeToLive: number

Returns

the number of seconds that a new ID token is valid for.

initiallyAuthenticatedUser

initiallyAuthenticatedUser: null | string

Returns

the authenticated user at the time that this client was registered. Notice that this is only valid for dynamically registered clients. Other clients will return null.

name

name: null | string

User-friendly name of this OAuth client.

prefixScopes

prefixScopes: {
    [key: string]: ConfiguredScope;
}

Returns

the configured prefix scopes for this OAuth client.

Type declaration

properties

properties: object

The properties of this client. The property values are typed, i.e. if they were stored with non-string values, which is possible for dynamically-registered clients, their type will be maintained. Notice that static clients can only have string-valued properties.

redirectUris

redirectUris: any[]

The authorized redirect URIs for this OAuth client.

refreshTokenTimeToLive

refreshTokenTimeToLive: number

Returns

the number of seconds that a new refresh token is valid for.

scope

scope: string

Deprecated

use [getScopeNames] instead.

Deprecated

scopeMap

scopeMap: ScopeMap

Get the scopes this OAuth client is configured with. This method returns a typed object that can be used to safely check requested scopes. Prefer to use this object than calling [getScopeNames] and using Set operations on that.@returns the scopes configured for this client.

scopeNames

scopeNames: any[]

Returns

the names of the scopes this OAuth client is configured with. Notice that this may include prefix scopes. Prefer to use [getScopes] or [getPrefixScopes] to obtain full information about the scopes configuration.

scopes

scopes: {
    [key: string]: ConfiguredScope;
}

Returns

all the configured scopes for this OAuth client.

Type declaration

secret

secret: null | string

The secret of this client. May be null if this client is not authenticated or uses a different method to authenticate.

Methods

allowConsentDeselection

  • Returns

    whether this OAuth client allows de-selecting consent for certain claims.

    Returns boolean

getAccessTokenTimeToLive

  • Returns

    the number of seconds that a new access token is valid for.

    Returns number

getAudiences

  • Returns

    the audiences of this OAuth client.

    Returns any[]

getAudiencesAsString

  • Returns

    the whitespace-separated audiences of this OAuth client.

    Returns string

getClaims

  • Returns

    a map containing all claims that this OAuth client is allowed to request for tokens.

    Returns {
        [key: string]: RequestedClaim;
    }

getClientId

  • Deprecated

    use getId() instead.

    Returns string

getClientName

  • Deprecated

    use getName() instead.

    Returns null | string

getDelegationTimeToLive

  • Returns

    the number of seconds that a new delegation is valid for.

    Returns number

getDescription

  • A description of this OAuth client.

    Returns null | string

getId

  • The ID of the OAuth client as configured in Curity.

    Returns string

getIdTokenIssuer

  • Returns

    the ID token issuer if configured for this client, or null otherwise.

    Returns null | string

getIdTokenTimeToLive

  • Returns

    the number of seconds that a new ID token is valid for.

    Returns number

getInitiallyAuthenticatedUser

  • Returns

    the authenticated user at the time that this client was registered. Notice that this is only valid for dynamically registered clients. Other clients will return null.

    Returns null | string

getName

  • User-friendly name of this OAuth client.

    Returns null | string

getPrefixScopes

  • Returns

    the configured prefix scopes for this OAuth client.

    Returns {
        [key: string]: ConfiguredScope;
    }

getProperties

  • The properties of this client. The property values are typed, i.e. if they were stored with non-string values, which is possible for dynamically-registered clients, their type will be maintained. Notice that static clients can only have string-valued properties.

    Returns object

getRedirectUris

  • The authorized redirect URIs for this OAuth client.

    Returns any[]

getRefreshTokenTimeToLive

  • Returns

    the number of seconds that a new refresh token is valid for.

    Returns number

getScope

  • Deprecated

    use [getScopeNames] instead.

    Deprecated

    Returns string

getScopeMap

  • Get the scopes this OAuth client is configured with. This method returns a typed object that can be used to safely check requested scopes. Prefer to use this object than calling [getScopeNames] and using Set operations on that.@returns the scopes configured for this client.

    Returns ScopeMap

getScopeNames

  • Returns

    the names of the scopes this OAuth client is configured with. Notice that this may include prefix scopes. Prefer to use [getScopes] or [getPrefixScopes] to obtain full information about the scopes configuration.

    Returns any[]

getScopes

  • Returns

    all the configured scopes for this OAuth client.

    Returns {
        [key: string]: ConfiguredScope;
    }

getSecret

  • The secret of this client. May be null if this client is not authenticated or uses a different method to authenticate.

    Returns null | string

isPublic

  • Returns

    whether this is a public client. If not, this is a confidential client.

    Returns boolean

requiresConsent

  • Returns

    whether this OAuth client requires user consent on authorization flows.

    Deprecated

    use requiresUserConsent() instead.

    Returns boolean

requiresUserConsent

  • Returns

    whether this OAuth client requires user consent on authorization flows.

    Returns boolean

Settings

Member Visibility

Theme