META-INF.apidocs.nl.praegus.fitnesse.slim.fixtures.adfs.MsTokenGenerator.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of toolchain-fixtures Show documentation
Extensions on existing fixtures to aid in automated testing
There is a newer version: 1.38.1
{
  "constructors" : [ {
    "readableName" : "ms token generator",
    "usage" : "| ms token generator |",
    "name" : "MsTokenGenerator",
    "docString" : "Generate access & refresh tokens using microsoft login.\n To use this fixture, the allowPublicClient key in your application's manifest must be set to true.\n Set clientId, resourceUri and authority before authenticating.",
    "annotations" : [ ],
    "parameters" : [ ],
    "exceptions" : [ ]
  }, {
    "readableName" : "ms token generator",
    "usage" : "| ms token generator | [clientId] | [resourceUri] | [authority] |",
    "name" : "MsTokenGenerator",
    "docString" : "Generate access & refresh tokens using microsoft login.\n To use this fixture, the allowPublicClient key in your application's manifest must be set to true.\n@param clientId The clientID of the app to authenticate against\n@param resourceUri The resourceURI of the api you want a token for\n@param authority The authority url (usually https://login.microsoftonline.com/[tenantId] or a default authority\n                  such as https://login.microsoftonline.com/organizations",
    "annotations" : [ ],
    "parameters" : [ {
      "name" : "clientId",
      "description" : "The clientID of the app to authenticate against",
      "type" : "String"
    }, {
      "name" : "resourceUri",
      "description" : "The resourceURI of the api you want a token for",
      "type" : "String"
    }, {
      "name" : "authority",
      "description" : "The authority url (usually https://login.microsoftonline.com/[tenantId] or a default authority\n                  such as https://login.microsoftonline.com/organizations",
      "type" : "String"
    } ],
    "exceptions" : [ ]
  } ],
  "qualifiedName" : "nl.praegus.fitnesse.slim.fixtures.adfs.MsTokenGenerator",
  "publicMethods" : [ {
    "readableName" : "authority",
    "usage" : "| authority | [authority] | ",
    "contexthelp" : "authority <authority>",
    "name" : "authority",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ {
      "name" : "authority",
      "type" : "String"
    } ],
    "exceptions" : [ ],
    "returnType" : "void"
  }, {
    "readableName" : "client id",
    "usage" : "| client id | [clientId] | ",
    "contexthelp" : "client id <clientId>",
    "name" : "clientId",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ {
      "name" : "clientId",
      "type" : "String"
    } ],
    "exceptions" : [ ],
    "returnType" : "void"
  }, {
    "readableName" : "resource uri",
    "usage" : "| resource uri | [resourceUri] | ",
    "contexthelp" : "resource uri <resourceUri>",
    "name" : "resourceUri",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ {
      "name" : "resourceUri",
      "type" : "String"
    } ],
    "exceptions" : [ ],
    "returnType" : "void"
  }, {
    "readableName" : "client id",
    "usage" : "| client id |",
    "contexthelp" : "client id",
    "name" : "clientId",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ ],
    "exceptions" : [ ],
    "returnType" : "String"
  }, {
    "readableName" : "resource uri",
    "usage" : "| resource uri |",
    "contexthelp" : "resource uri",
    "name" : "resourceUri",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ ],
    "exceptions" : [ ],
    "returnType" : "String"
  }, {
    "readableName" : "authority",
    "usage" : "| authority |",
    "contexthelp" : "authority",
    "name" : "authority",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ ],
    "exceptions" : [ ],
    "returnType" : "String"
  }, {
    "readableName" : "access token",
    "usage" : "| access token |",
    "contexthelp" : "access token",
    "name" : "accessToken",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ ],
    "exceptions" : [ ],
    "returnType" : "String"
  }, {
    "readableName" : "refresh token",
    "usage" : "| refresh token |",
    "contexthelp" : "refresh token",
    "name" : "refreshToken",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ ],
    "exceptions" : [ ],
    "returnType" : "String"
  }, {
    "readableName" : "authenticate with username password",
    "usage" : "| authenticate with username | [username] | password | [password] | ",
    "contexthelp" : "authenticate with username <username> password <password>",
    "name" : "authenticateWithUsernamePassword",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ {
      "name" : "username",
      "type" : "String"
    }, {
      "name" : "password",
      "type" : "String"
    } ],
    "exceptions" : [ ],
    "returnType" : "boolean"
  } ],
  "typeName" : "nl.praegus.fitnesse.slim.fixtures.adfs.MsTokenGenerator",
  "name" : "MsTokenGenerator",
  "annotations" : [ ]
}