![]() The first call to POST Auth/SignAppIn logs the user in, as long as the authentication request to the two-factor server does not time out. If the two-factor server is configured to authenticate through a push or mobile two-factor challenge, a challenge response is often not required. Two-Factor Authenticationĭepending on how the two-factor server is configured, a programmatic two-factor challenge is sometimes required. ![]() When using a domain user, depending on the programming or scripting tool used, you may need to escape the backslash (\) character between the domain name and username. The API keys in the examples have been shortened for brevity. pwd: The RunAs user password surrounded by square brackets (optional required only if the User Password is required on the application API registration).Īuthorization=PS-Auth key=c479a66f…c9484d runas=doe-main\johndoe pwd=.runas: The username of a BeyondInsight user that has been granted permission to use the API key.key: The API key configured in BeyondInsight for your application.Use the web request authorization header to communicate the API application key, the RunAs username, and the user password: SSL is required to use the Password Safe Public API. = BeyondTrust/api/public/v3įor cloud instances, the-cloud-instance-url is a placeholder and should be replaced with the cloud instance URL in your environment. For on-premises instances, the-server is a placeholder and should be replaced with the server name in your environment. The following base endpoint is used throughout this document. Initiate a session using API POST Auth/SignAppIn and always call POST Auth/Signout when you are done. ![]() The method is dependent on the scripting language. Session state is maintained between API calls. Rotating the API Key produces the new-style API key described above. Some environments may still use an old-style API key, which is a formatted Globally Unique Identifier (GUID). Any language with a Representational State Transfer (REST) compliant interface can access the API with the API key and RunAs in the authorization header. It is encrypted and stored internally using AES 256 encryption. The API key is a cryptographically strong random sequence of numbers hashed into a 128-character string.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |