Class AuthenticationOauthProviderService

Hierarchy

  • AuthenticationOauthProviderService

Constructors

constructor

Methods

createMsgVpnAuthenticationOauthProvider deleteMsgVpnAuthenticationOauthProvider getMsgVpnAuthenticationOauthProvider getMsgVpnAuthenticationOauthProviders replaceMsgVpnAuthenticationOauthProvider updateMsgVpnAuthenticationOauthProvider

Constructors

constructor

Methods

Static createMsgVpnAuthenticationOauthProvider

  • Deprecated

    Create an OAuth Provider object. Create an OAuth Provider object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.

    OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    audienceClaimName x
    audienceClaimSource x
    audienceClaimValue x
    audienceValidationEnabled x
    authorizationGroupClaimName x
    authorizationGroupClaimSource x
    authorizationGroupEnabled x
    disconnectOnTokenExpirationEnabled x
    enabled x
    jwksRefreshInterval x
    jwksUri x
    msgVpnName x x x
    oauthProviderName x x x
    tokenIgnoreTimeLimitsEnabled x
    tokenIntrospectionParameterName x
    tokenIntrospectionPassword x x x
    tokenIntrospectionTimeout x
    tokenIntrospectionUri x
    tokenIntrospectionUsername x
    usernameClaimName x
    usernameClaimSource x
    usernameValidateEnabled x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation.

    This has been deprecated since 2.25. Replaced by authenticationOauthProfiles.

    Returns

    MsgVpnAuthenticationOauthProviderResponse The OAuth Provider object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnAuthenticationOauthProvider;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnAuthenticationOauthProvider

        The OAuth Provider object's attributes. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnAuthenticationOauthProviderResponse | SempMetaOnlyResponse>

Static deleteMsgVpnAuthenticationOauthProvider

  • Deprecated

    Delete an OAuth Provider object. Delete an OAuth Provider object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.

    OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.

    A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation.

    This has been deprecated since 2.25. Replaced by authenticationOauthProfiles.

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          msgVpnName: string;
          oauthProviderName: string;
          xContextId?: string;
      }
      • msgVpnName: string

        The name of the Message VPN. *

      • oauthProviderName: string

        The name of the OAuth Provider. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

Static getMsgVpnAuthenticationOauthProvider

  • Deprecated

    Get an OAuth Provider object. Get an OAuth Provider object.

    OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.

    Attribute Identifying Write-Only Deprecated Opaque
    audienceClaimName x
    audienceClaimSource x
    audienceClaimValue x
    audienceValidationEnabled x
    authorizationGroupClaimName x
    authorizationGroupClaimSource x
    authorizationGroupEnabled x
    disconnectOnTokenExpirationEnabled x
    enabled x
    jwksRefreshInterval x
    jwksUri x
    msgVpnName x x
    oauthProviderName x x
    tokenIgnoreTimeLimitsEnabled x
    tokenIntrospectionParameterName x
    tokenIntrospectionPassword x x x
    tokenIntrospectionTimeout x
    tokenIntrospectionUri x
    tokenIntrospectionUsername x
    usernameClaimName x
    usernameClaimSource x
    usernameValidateEnabled x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.

    This has been deprecated since 2.25. Replaced by authenticationOauthProfiles.

    Returns

    MsgVpnAuthenticationOauthProviderResponse The OAuth Provider object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          msgVpnName: string;
          oauthProviderName: string;
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • msgVpnName: string

        The name of the Message VPN. *

      • oauthProviderName: string

        The name of the OAuth Provider. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnAuthenticationOauthProviderResponse | SempMetaOnlyResponse>

Static getMsgVpnAuthenticationOauthProviders

  • Deprecated

    Get a list of OAuth Provider objects. Get a list of OAuth Provider objects.

    OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.

    Attribute Identifying Write-Only Deprecated Opaque
    audienceClaimName x
    audienceClaimSource x
    audienceClaimValue x
    audienceValidationEnabled x
    authorizationGroupClaimName x
    authorizationGroupClaimSource x
    authorizationGroupEnabled x
    disconnectOnTokenExpirationEnabled x
    enabled x
    jwksRefreshInterval x
    jwksUri x
    msgVpnName x x
    oauthProviderName x x
    tokenIgnoreTimeLimitsEnabled x
    tokenIntrospectionParameterName x
    tokenIntrospectionPassword x x x
    tokenIntrospectionTimeout x
    tokenIntrospectionUri x
    tokenIntrospectionUsername x
    usernameClaimName x
    usernameClaimSource x
    usernameValidateEnabled x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.

    This has been deprecated since 2.25. Replaced by authenticationOauthProfiles.

    Returns

    MsgVpnAuthenticationOauthProvidersResponse The list of OAuth Provider objects' attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          count?: number;
          cursor?: string;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          where?: string[];
          xContextId?: string;
      }
      • Optional count?: number

        Limit the count of objects in the response. See the documentation for the count parameter. *

      • Optional cursor?: string

        The cursor, or position, for the next page of objects. See the documentation for the cursor parameter. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional where?: string[]

        Include in the response only objects where certain conditions are true. See the the documentation for the where parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnAuthenticationOauthProvidersResponse | SempMetaOnlyResponse>

Static replaceMsgVpnAuthenticationOauthProvider

  • Deprecated

    Replace an OAuth Provider object. Replace an OAuth Provider object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.

    OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.

    Attribute Identifying Const Read-Only Write-Only Requires-Disable Deprecated Opaque
    audienceClaimName x
    audienceClaimSource x
    audienceClaimValue x
    audienceValidationEnabled x
    authorizationGroupClaimName x
    authorizationGroupClaimSource x
    authorizationGroupEnabled x
    disconnectOnTokenExpirationEnabled x
    enabled x
    jwksRefreshInterval x
    jwksUri x
    msgVpnName x x x
    oauthProviderName x x x
    tokenIgnoreTimeLimitsEnabled x
    tokenIntrospectionParameterName x
    tokenIntrospectionPassword x x x
    tokenIntrospectionTimeout x
    tokenIntrospectionUri x
    tokenIntrospectionUsername x
    usernameClaimName x
    usernameClaimSource x
    usernameValidateEnabled x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation.

    This has been deprecated since 2.25. Replaced by authenticationOauthProfiles.

    Returns

    MsgVpnAuthenticationOauthProviderResponse The OAuth Provider object's attributes after being replaced, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnAuthenticationOauthProvider;
          msgVpnName: string;
          oauthProviderName: string;
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnAuthenticationOauthProvider

        The OAuth Provider object's attributes. *

      • msgVpnName: string

        The name of the Message VPN. *

      • oauthProviderName: string

        The name of the OAuth Provider. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnAuthenticationOauthProviderResponse | SempMetaOnlyResponse>

Static updateMsgVpnAuthenticationOauthProvider

  • Deprecated

    Update an OAuth Provider object. Update an OAuth Provider object. Any attribute missing from the request will be left unchanged.

    OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.

    Attribute Identifying Read-Only Write-Only Requires-Disable Deprecated Opaque
    audienceClaimName x
    audienceClaimSource x
    audienceClaimValue x
    audienceValidationEnabled x
    authorizationGroupClaimName x
    authorizationGroupClaimSource x
    authorizationGroupEnabled x
    disconnectOnTokenExpirationEnabled x
    enabled x
    jwksRefreshInterval x
    jwksUri x
    msgVpnName x x x
    oauthProviderName x x x
    tokenIgnoreTimeLimitsEnabled x
    tokenIntrospectionParameterName x
    tokenIntrospectionPassword x x x
    tokenIntrospectionTimeout x
    tokenIntrospectionUri x
    tokenIntrospectionUsername x
    usernameClaimName x
    usernameClaimSource x
    usernameValidateEnabled x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation.

    This has been deprecated since 2.25. Replaced by authenticationOauthProfiles.

    Returns

    MsgVpnAuthenticationOauthProviderResponse The OAuth Provider object's attributes after being updated, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnAuthenticationOauthProvider;
          msgVpnName: string;
          oauthProviderName: string;
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnAuthenticationOauthProvider

        The OAuth Provider object's attributes. *

      • msgVpnName: string

        The name of the Message VPN. *

      • oauthProviderName: string

        The name of the OAuth Provider. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnAuthenticationOauthProviderResponse | SempMetaOnlyResponse>

Settings

Member Visibility

Theme