Class AuthenticationOauthProfileService

Hierarchy

  • AuthenticationOauthProfileService

Constructors

constructor

Methods

createMsgVpnAuthenticationOauthProfile createMsgVpnAuthenticationOauthProfileClientRequiredClaim createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim deleteMsgVpnAuthenticationOauthProfile deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim getMsgVpnAuthenticationOauthProfile getMsgVpnAuthenticationOauthProfileClientRequiredClaim getMsgVpnAuthenticationOauthProfileClientRequiredClaims getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims getMsgVpnAuthenticationOauthProfiles replaceMsgVpnAuthenticationOauthProfile updateMsgVpnAuthenticationOauthProfile

Constructors

constructor

Methods

Static createMsgVpnAuthenticationOauthProfile

  • Create an OAuth Profile object. Create an OAuth Profile 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 profiles specify how to securely authenticate to an OAuth provider.

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    clientSecret x x
    msgVpnName x x
    oauthProfileName x x

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

    This has been available since 2.25.

    Returns

    MsgVpnAuthenticationOauthProfileResponse The OAuth Profile object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The OAuth Profile 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<MsgVpnAuthenticationOauthProfileResponse | SempMetaOnlyResponse>

Static createMsgVpnAuthenticationOauthProfileClientRequiredClaim

  • Create a Required Claim object. Create a Required Claim 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.

    Additional claims to be verified in the ID token.

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    clientRequiredClaimName x x
    clientRequiredClaimValue x
    msgVpnName x x
    oauthProfileName x x

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

    This has been available since 2.25.

    Returns

    MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse The Required Claim object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The Required Claim object's attributes. *

      • msgVpnName: string

        The name of the Message VPN. *

      • oauthProfileName: string

        The name of the OAuth profile. *

      • 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<MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse | SempMetaOnlyResponse>

Static createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim

  • Create a Required Claim object. Create a Required Claim 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.

    Additional claims to be verified in the access token.

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    msgVpnName x x
    oauthProfileName x x
    resourceServerRequiredClaimName x x
    resourceServerRequiredClaimValue x

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

    This has been available since 2.25.

    Returns

    MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse The Required Claim object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The Required Claim object's attributes. *

      • msgVpnName: string

        The name of the Message VPN. *

      • oauthProfileName: string

        The name of the OAuth profile. *

      • 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<MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse | SempMetaOnlyResponse>

Static deleteMsgVpnAuthenticationOauthProfile

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

    OAuth profiles specify how to securely authenticate to an OAuth provider.

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

    This has been available since 2.25.

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

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

        The name of the Message VPN. *

      • oauthProfileName: string

        The name of the OAuth profile. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

Static deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim

  • Delete a Required Claim object. Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.

    Additional claims to be verified in the ID token.

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

    This has been available since 2.25.

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          clientRequiredClaimName: string;
          msgVpnName: string;
          oauthProfileName: string;
          xContextId?: string;
      }
      • clientRequiredClaimName: string

        The name of the ID token claim to verify. *

      • msgVpnName: string

        The name of the Message VPN. *

      • oauthProfileName: string

        The name of the OAuth profile. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

Static deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim

  • Delete a Required Claim object. Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.

    Additional claims to be verified in the access token.

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

    This has been available since 2.25.

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          msgVpnName: string;
          oauthProfileName: string;
          resourceServerRequiredClaimName: string;
          xContextId?: string;
      }
      • msgVpnName: string

        The name of the Message VPN. *

      • oauthProfileName: string

        The name of the OAuth profile. *

      • resourceServerRequiredClaimName: string

        The name of the access token claim to verify. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

Static getMsgVpnAuthenticationOauthProfile

  • Get an OAuth Profile object. Get an OAuth Profile object.

    OAuth profiles specify how to securely authenticate to an OAuth provider.

    Attribute Identifying Write-Only Deprecated Opaque
    clientSecret x x
    msgVpnName x
    oauthProfileName x

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

    This has been available since 2.25.

    Returns

    MsgVpnAuthenticationOauthProfileResponse The OAuth Profile object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The name of the Message VPN. *

      • oauthProfileName: string

        The name of the OAuth profile. *

      • 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<MsgVpnAuthenticationOauthProfileResponse | SempMetaOnlyResponse>

Static getMsgVpnAuthenticationOauthProfileClientRequiredClaim

  • Get a Required Claim object. Get a Required Claim object.

    Additional claims to be verified in the ID token.

    Attribute Identifying Write-Only Deprecated Opaque
    clientRequiredClaimName x
    msgVpnName x
    oauthProfileName x

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

    This has been available since 2.25.

    Returns

    MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse The Required Claim object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The name of the ID token claim to verify. *

      • msgVpnName: string

        The name of the Message VPN. *

      • oauthProfileName: string

        The name of the OAuth profile. *

      • 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<MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse | SempMetaOnlyResponse>

Static getMsgVpnAuthenticationOauthProfileClientRequiredClaims

  • Get a list of Required Claim objects. Get a list of Required Claim objects.

    Additional claims to be verified in the ID token.

    Attribute Identifying Write-Only Deprecated Opaque
    clientRequiredClaimName x
    msgVpnName x
    oauthProfileName x

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

    This has been available since 2.25.

    Returns

    MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse The list of Required Claim objects' attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          count?: number;
          cursor?: string;
          msgVpnName: string;
          oauthProfileName: 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. *

      • oauthProfileName: string

        The name of the OAuth profile. *

      • 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<MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse | SempMetaOnlyResponse>

Static getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim

  • Get a Required Claim object. Get a Required Claim object.

    Additional claims to be verified in the access token.

    Attribute Identifying Write-Only Deprecated Opaque
    msgVpnName x
    oauthProfileName x
    resourceServerRequiredClaimName x

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

    This has been available since 2.25.

    Returns

    MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse The Required Claim object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The name of the Message VPN. *

      • oauthProfileName: string

        The name of the OAuth profile. *

      • 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. *

      • resourceServerRequiredClaimName: string

        The name of the access token claim to verify. *

      • 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<MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse | SempMetaOnlyResponse>

Static getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims

  • Get a list of Required Claim objects. Get a list of Required Claim objects.

    Additional claims to be verified in the access token.

    Attribute Identifying Write-Only Deprecated Opaque
    msgVpnName x
    oauthProfileName x
    resourceServerRequiredClaimName x

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

    This has been available since 2.25.

    Returns

    MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse The list of Required Claim objects' attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          count?: number;
          cursor?: string;
          msgVpnName: string;
          oauthProfileName: 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. *

      • oauthProfileName: string

        The name of the OAuth profile. *

      • 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<MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse | SempMetaOnlyResponse>

Static getMsgVpnAuthenticationOauthProfiles

  • Get a list of OAuth Profile objects. Get a list of OAuth Profile objects.

    OAuth profiles specify how to securely authenticate to an OAuth provider.

    Attribute Identifying Write-Only Deprecated Opaque
    clientSecret x x
    msgVpnName x
    oauthProfileName x

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

    This has been available since 2.25.

    Returns

    MsgVpnAuthenticationOauthProfilesResponse The list of OAuth Profile 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<MsgVpnAuthenticationOauthProfilesResponse | SempMetaOnlyResponse>

Static replaceMsgVpnAuthenticationOauthProfile

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

    OAuth profiles specify how to securely authenticate to an OAuth provider.

    Attribute Identifying Const Read-Only Write-Only Requires-Disable Deprecated Opaque
    clientSecret x x
    msgVpnName x x
    oauthProfileName x x

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

    This has been available since 2.25.

    Returns

    MsgVpnAuthenticationOauthProfileResponse The OAuth Profile object's attributes after being replaced, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The OAuth Profile object's attributes. *

      • msgVpnName: string

        The name of the Message VPN. *

      • oauthProfileName: string

        The name of the OAuth profile. *

      • 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<MsgVpnAuthenticationOauthProfileResponse | SempMetaOnlyResponse>

Static updateMsgVpnAuthenticationOauthProfile

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

    OAuth profiles specify how to securely authenticate to an OAuth provider.

    Attribute Identifying Read-Only Write-Only Requires-Disable Deprecated Opaque
    clientSecret x x
    msgVpnName x x
    oauthProfileName x x

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

    This has been available since 2.25.

    Returns

    MsgVpnAuthenticationOauthProfileResponse The OAuth Profile object's attributes after being updated, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The OAuth Profile object's attributes. *

      • msgVpnName: string

        The name of the Message VPN. *

      • oauthProfileName: string

        The name of the OAuth profile. *

      • 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<MsgVpnAuthenticationOauthProfileResponse | SempMetaOnlyResponse>

Settings

Member Visibility

Theme