Skip to main content
Glama

loginmethod-update

Create or update authentication methods for connectors to access external systems, supporting UserCredentials, OAuth2, Token, and SAP-SSO login types with various configuration options.

Instructions

Create or update a Login Method

Create or update login methods for authenticating connectors with external systems.

Supported Types:

  • UserCredentials (BasicAuth): Username/password authentication

  • OAuth2: OAuth2 client-based authentication

  • Token: Token-based authentication (API keys, SimplifierToken)

  • SAPSSO: SAP-Single Sign on via Logon Ticket

Note that the type of a login method cannot be changed later. If you need to change the type, create a new login method instead.

UserCredentials (BasicAuth)

Creates or updates a basic authentication login method with various source types.

UserCredentials with Provided Source (Default)

Stores username and password directly in the login method.

Configuration:

  • loginMethodType: "UserCredentials"

  • sourceType: "Provided" (source ID: 1) - default

  • Target: Default (target ID: 0) - standard authentication header

Example - Creating BasicAuth:

{
  "loginMethodType": "UserCredentials",
  "sourceType": "Provided",
  "name": "MyBasicAuth",
  "description": "Basic auth for API",
  "username": "admin",
  "password": "secretPassword"
}

Example - Updating BasicAuth password:

{
  "loginMethodType": "UserCredentials",
  "sourceType": "Provided",
  "name": "MyBasicAuth",
  "description": "Updated description",
  "username": "admin",
  "password": "newPassword",
  "changePassword": true
}

UserCredentials with Profile Reference

References a key in the user's profile.

Example:

{
  "loginMethodType": "UserCredentials",
  "sourceType": "ProfileReference",
  "name": "MyBasicAuth",
  "description": "BasicAuth from user profile",
  "profileKey": "credentialsKey"
}

UserCredentials with User Attribute Reference

References a user attribute by name and category.

Example:

{
  "loginMethodType": "UserCredentials",
  "sourceType": "UserAttributeReference",
  "name": "MyBasicAuth",
  "description": "BasicAuth from user attribute",
  "userAttributeName": "myAttrName",
  "userAttributeCategory": "myAttrCat"
}

OAuth2 Login Methods

Creates or updates OAuth2-based login methods with various source configurations.

IMPORTANT: When creating an OAuth2 login method with a client reference, the oauth2ClientName MUST match one of the existing OAuth2 clients configured in Simplifier. You can discover available clients using the simplifier://oauthclients resource before creating the login method.

OAuth2 with Client Reference

Uses a configured OAuth2 client from Simplifier. Discover available clients: Use simplifier://oauthclients resource

Configuration:

  • loginMethodType: "OAuth2"

  • sourceType: "ClientReference"

  • Target: 0 = default header, 1 = custom header, 2 = query parameter

Example - Default header:

{
  "loginMethodType": "OAuth2",
  "sourceType": "ClientReference",
  "name": "MyOAuth",
  "description": "OAuth with infraOIDC",
  "oauth2ClientName": "infraOIDC",
  "targetType": "Default"
}

Example - Custom header:

{
  "loginMethodType": "OAuth2",
  "sourceType": "ClientReference",
  "name": "MyOAuth",
  "description": "OAuth with custom header",
  "oauth2ClientName": "infraOIDC",
  "targetType": "CustomHeader",
  "customHeaderName": "X-Custom-Auth"
}

Example - Query parameter:

{
  "loginMethodType": "OAuth2",
  "sourceType": "ClientReference",
  "name": "MyOAuth",
  "description": "OAuth as query param",
  "oauth2ClientName": "infraOIDC",
  "targetType": "QueryParameter",
  "queryParameterKey": "authToken"
}

OAuth2 with Profile Reference

References a key in the user's profile.

Example:

{
  "loginMethodType": "OAuth2",
  "sourceType": "ProfileReference",
  "name": "MyOAuth",
  "description": "OAuth from user profile",
  "profileKey": "oauthToken",
  "targetType": "Default"
}

OAuth2 with User Attribute Reference

References a user attribute by name and category.

Example:

{
  "loginMethodType": "OAuth2",
  "sourceType": "UserAttributeReference",
  "name": "MyOAuth",
  "description": "OAuth from user attribute",
  "userAttributeName": "myAttrName",
  "userAttributeCategory": "myAttrCat",
  "targetType": "Default"
}

Token Login Methods

Creates or updates Token-based login methods for API authentication, including SimplifierToken support. Can be used for API-KEYs or for tokens, that you have received with former Simplifier Auth Clients and stored in the UserProfile or in the UserAttributes. In case you have received a token from a former connector call, you might want to add the token with every call in a header via a connector call input parameter.

Token with Default Source

Uses an empty configuration (no credentials stored). Typically used as a placeholder.

Configuration:

  • loginMethodType: "Token"

  • sourceType: "Default" (source ID: 0)

  • Target: 0 = default header, 1 = custom header

Example:

{
  "loginMethodType": "Token",
  "sourceType": "Default",
  "name": "MyTokenDefault",
  "description": "Token with default source",
  "targetType": "Default"
}

Token with SystemReference Source

Uses the SimplifierToken for authentication. This is the primary use case for authenticating Simplifier apps accessing the REST API.

Configuration:

  • loginMethodType: "Token"

  • sourceType: "SystemReference" (source ID: 3)

  • Target: 0 = default header, 1 = custom header

Example:

{
  "loginMethodType": "Token",
  "sourceType": "SystemReference",
  "name": "SimplifierTokenAuth",
  "description": "Uses SimplifierToken",
  "targetType": "Default"
}

Token with Provided Source

Stores a token value directly in the login method. Useful for API keys.

Configuration:

  • loginMethodType: "Token"

  • sourceType: "Provided" (source ID: 1)

  • Target: 0 = default header, 1 = custom header

Example - Creating Token:

{
  "loginMethodType": "Token",
  "sourceType": "Provided",
  "name": "MyAPIKey",
  "description": "API key authentication",
  "token": "mySecretToken123",
  "targetType": "Default"
}

Example - Updating Token value:

{
  "loginMethodType": "Token",
  "sourceType": "Provided",
  "name": "MyAPIKey",
  "description": "Updated API key",
  "token": "newSecretToken456",
  "changeToken": true
}

Example - Updating description only (without changing token):

{
  "loginMethodType": "Token",
  "sourceType": "Provided",
  "name": "MyAPIKey",
  "description": "Updated description only",
  "token": "<not relevant>",
  "changeToken": false
}

Token with Custom Header

Place the token in a custom HTTP header.

Example:

{
  "loginMethodType": "Token",
  "sourceType": "Provided",
  "name": "MyAPIKeyHeader",
  "description": "Token in custom header",
  "token": "myToken123",
  "targetType": "CustomHeader",
  "customHeaderName": "X-API-Token"
}

Token with Profile Reference

References a token stored in the user's profile.

Example:

{
  "loginMethodType": "Token",
  "sourceType": "ProfileReference",
  "name": "MyTokenFromProfile",
  "description": "Token from user profile",
  "profileKey": "apiTokenKey",
  "targetType": "Default"
}

Token with User Attribute Reference

References a token from a user attribute.

Example:

{
  "loginMethodType": "Token",
  "sourceType": "UserAttributeReference",
  "name": "MyTokenFromAttr",
  "description": "Token from user attribute",
  "userAttributeName": "tokenAttribute",
  "userAttributeCategory": "security",
  "targetType": "Default"
}

SAP-SSO Login Methods

Creates or updates SAP-SSO login methods for API authentication. Can be used for users authenticated against a SAP authentication method or with a constant value or one stored in the UserProfile or in the UserAttributes.

SAP-SSO with Default Source

Uses an empty configuration (no credentials stored). Uses the SAP Logon Ticket from the user, which needs to be logged in using SAP-SSO.

Configuration:

  • loginMethodType: "SAPSSO"

  • sourceType: "Default" (source ID: 0)

  • Target: 0 = default

Example:

{
  "loginMethodType": "SAPSSO",
  "sourceType": "Default",
  "name": "MySAPSSODefault",
  "description": "SAPSSO with default source",
  "targetType": "Default"
}

SAP-SSO with Provided Source

Stores a logon ticket value directly in the login method. Useful for API keys.

Configuration:

  • loginMethodType: "SAPSSO"

  • sourceType: "Provided" (source ID: 1)

  • Target: 0 = default header, 1 = custom header

Example - Creating SAP-SSO:

{
  "loginMethodType": "SAPSSO",
  "sourceType": "Provided",
  "name": "MyAPIKey",
  "description": "SAP-SSO with constant logon ticket authentication",
  "ticket": "mySecretToken123",
  "targetType": "Default"
}

Example - Updating ticket value:

{
  "loginMethodType": "SAPSSO",
  "sourceType": "Provided",
  "name": "MyAPIKey",
  "description": "SAP-SSO with constant logon ticket authentication",
  "ticket": "newSecretToken456",
  "changeToken": true
}

Example - Updating description only (without changing ticket):

{
  "loginMethodType": "SAPSSO",
  "sourceType": "Provided",
  "name": "MyAPIKey",
  "description": "Updated description only",
  "ticket": "<not relevant>",
  "changeToken": false
}

SAP-SSO with Profile Reference

References a ticket stored in the user's profile.

Example:

{
  "loginMethodType": "SAPSSO",
  "sourceType": "ProfileReference",
  "name": "MyTicketFromProfile",
  "description": "Ticket from user profile",
  "profileKey": "apiTicket",
  "targetType": "Default"
}

SAP-SSO with User Attribute Reference

References a ticket from a user attribute.

Example:

{
  "loginMethodType": "SAPSSO",
  "sourceType": "UserAttributeReference",
  "name": "MyTicketFromAttr",
  "description": "Ticket from user attribute",
  "userAttributeName": "ticketAttribute",
  "userAttributeCategory": "security",
  "targetType": "Default"
}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
loginMethodTypeYesType of login method: UserCredentials for BasicAuth, OAuth2 for OAuth2-based auth, Token for token-based auth, SingleSignOn for SAP-SSO Logon Ticket
nameYesName of the login method
descriptionYesDescription of the login method
sourceTypeNoSource type: * Default (system default - credentials for UserCredentials, OAuth2 client for OAuth2, empty for Token, user logon ticket for SAP-SSO) * SystemReference (Token - uses SimplifierToken) * Provided (UserCredentials - username/password, Token - token value) * Reference (OAuth2 - OAuth2 client reference) * ProfileReference (user profile key) * UserAttributeReference (user attribute)
usernameNo[UserCredentials Default/Provided] Username for basic authentication. Must not be empty string. If the information is not given (i.e. in case of Microsoft PAT authentication), use a non empty placeholder
passwordNo[UserCredentials Default/Provided] Password for basic authentication
changePasswordNo[UserCredentials Default/Provided] Set to true when updating to change the password
tokenNo[Token Provided] Token value for authentication
changeTokenNo[Token Provided] Set to true when updating to change the token
ticketNo[SingleSignOn Provided] Ticket value for authentication
changeTicketNo[SingleSignOn Provided] Set to true when updating to change the ticket
oauth2ClientNameNo[OAuth2 Default/Reference] Name of the OAuth2 client (discover via simplifier://oauthclients). **Important**: The `oauth2ClientName` **MUST** match one of the existing OAuth2 clients configured in Simplifier. You should discover available clients using the `simplifier://oauthclients` resource before creating the login method.
profileKeyNo[ProfileReference] Key name in the user's profile
userAttributeNameNo[UserAttributeReference] Name of the user attribute
userAttributeCategoryNo[UserAttributeReference] Category of the user attribute
targetTypeNo[OAuth2/Token] Target type: Default (standard auth header), CustomHeader (custom header name), QueryParameter (query param - OAuth2 only)Default
customHeaderNameNo[OAuth2 CustomHeader] Name of the custom authentication header
queryParameterKeyNo[OAuth2 QueryParameter] Key name for the query parameter
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description adds valuable behavioral context beyond annotations. Annotations indicate this is a mutable, non-destructive operation (readOnlyHint: false, destructiveHint: false), but the description elaborates on update semantics, type immutability constraints, and provides specific examples for different authentication scenarios. It also mentions prerequisites like discovering OAuth2 clients, which adds practical implementation guidance.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is excessively long (over 150 lines) with redundant information. While well-structured with sections for each authentication type, it includes multiple repetitive examples and could be significantly condensed. The core concepts could be communicated in a fraction of the length without losing essential information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a complex tool with 18 parameters and no output schema, the description provides comprehensive coverage of authentication types, source configurations, and usage patterns. It addresses the main complexity areas through detailed examples. The main gap is the lack of information about return values or error conditions, but given the tool's complexity, the description does an above-average job of providing context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Despite 100% schema description coverage, the description adds substantial value through comprehensive examples that illustrate parameter combinations for different authentication types. It provides concrete JSON configurations for UserCredentials, OAuth2, Token, and SAPSSO methods with various source types, showing how parameters interact in real-world scenarios far beyond what the schema descriptions provide.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: 'Create or update login methods for authenticating connectors with external systems.' It specifies the verb (create/update) and resource (login methods), and distinguishes from siblings by focusing on authentication configuration rather than business objects, connectors, or other system components.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides some usage context by listing supported authentication types and noting that 'the type of a login method cannot be changed later,' but it doesn't explicitly state when to use this tool versus alternatives. While it mentions discovering OAuth2 clients before creation, there's no guidance on when to choose this tool over other authentication configuration methods or when not to use it.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/simplifier-ag/simplifier-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server