Obtaining an Agency Token

Function

URI

Request Parameters

• Parameters in the request header

  Parameter	Mandatory	Type	Description
  Content-Type	Yes	String	Fill application/json;charset=utf8 in this field.
  X-Auth-Token	Yes	String	Token that assigns the permissions of the Agent Operator policy to user B.

• Parameters in the request body

  Parameter	Mandatory	Type	Description
  auth	Yes	Object	Authentication information.

• auth

  Parameter	Mandatory	Type	Description
  identity	Yes	Object	Authentication parameters, including: methods and assume_role. "identity": { "methods": ["assume_role"], "assume_role": {
  scope	Yes	Object	Application scope of the token. The value can be project or domain. If this field is set to project, the token can only be used to access resources in the project of a specified ID or name. "scope": { "project": { "id": "0b95b78b67fa045b38104c12fb..." } } If this field is set to domain, the token can be used to access all resources under the domain of a specified ID or name. "scope": { "domain": { "id": "6b8eb224c76842e3ac2..." } }

• auth.identity

  Parameter	Mandatory	Type	Description
  methods	Yes	Array of strings	Method for obtaining the token. Set this field to assume_role.
  assume_role	Yes	Object	Details about the agency and delegating party.

• auth.identity.assume_role

  Parameter	Mandatory	Type	Description
  domain_id	No	String	Domain ID of the delegating party A. Either domain_id or domain_name must be specified.
  domain_name	No	String	Domain name of the delegating party A. Either domain_id or domain_name must be specified.
  agency_name	Yes	String	Name of the agency created by the delegating party A.

• auth.scope

  Parameter	Mandatory	Type	Description
  domain	No	Object	If this parameter is set to project, the token can only be used to access resources in the project of a specified ID or name.
  project	No	Object	If this parameter is set to domain, the token can be used to access all resources under the domain of a specified ID or name.

• auth.scope.domain

  Parameter	Mandatory	Type	Description
  id	No	String	Domain ID of the delegating party A. Either id or name must be specified.
  name	No	String	Domain name of the delegating party A. Either id or name must be specified.

• auth.scope.project

  Parameter	Mandatory	Type	Description
  id	No	String	Project ID of the delegating party A. Either id or name must be specified.
  name	No	String	Project name of the delegating party A. Either id or name must be specified.

Response Parameters

• Parameters in the response header

  Parameter	Mandatory	Type	Description
  X-Subject-Token	Yes	String	Agency token that is obtained.

• Parameters in the response body

  Parameter	Type	Description
  token	Object	Token information list.

• token

  Parameter	Type	Description
  methods	Array of strings	Method for obtaining the token.
  expires_at	String	Time when the token will expire.
  issued_at	String	Time when the token was issued.
  assumed_by	Object	Detailed information about the delegated party. Example: "assumed_by": { "user": { "domain": { "name": "domain B", "id": "bfdd55e02a014894b5a2693f31..." }, "name": "user B", "id": "ff5ea657f1dd45c4b8f398cab..." } } domain.name: Name of the domain to which the delegated party belongs. user.name: Username of the delegated party.
  catalog	Array of objects	Endpoint information. Example: "catalog": [{ "type": "identity", "id": "1331e5cff2a74d76b03da1225910e31d", "name": "iam", "endpoints": [{ "url": "https://sample.domain.com/v3", "region": "*", "region_id": "*", "interface": "public", "id": "089d4a381d574308a703122d3ae738e9" }] }]
  domain	Object	This parameter is returned only when the scope parameter in the request body has been set to domain. Example: "domain": { "name" : "domain A", "id" : "domainid" } domain.name: Name of the domain to which the delegating party belongs. domain.id: ID of the domain to which the delegating party belongs.
  project	Object	This parameter is returned only when the scope parameter in the request body has been set to project. Example: "project": { "name": "projectname", "id": "projectid" } project.name: project name. project.id: project ID.
  roles	Array of objects	Permissions information of the token. Example: "roles" : [{ "name" : "role1", "id" : "roleid1" }, { "name" : "role2", "id" : "roleid2" } ]
  user	Object	Detailed information about the delegating party. "user": { "name": "user A", "id": "userid", "password_expires_at":"2016-11-06T15:32:17.000000", "domain": { "name": "domain A", "id": "domainid" } } user.name: Username of the delegating party. user.id: User ID of the delegating party. domain.name: Name of the domain to which the delegating party belongs. domain.id: ID of the domain to which the delegating party belongs. (Optional) password_expires_at: UTC time when the password will expire. null indicates that the password will not expire.

  Table 1 token.assumed_by

  Parameter	Type	Description
  user	Object	Information about an IAM user of delegated party B.

  Table 2 token.assumed_by.user

  Parameter	Type	Description
  name	String	IAM username.
  id	String	IAM user ID.
  domain	Object	Domain information about delegated party B.
  password_expires_at	String	UTC time when the password of the IAM user will expire. If this parameter is null, the password will never expire.

  Table 3 token.assumed_by.user.domain

  Parameter	Type	Description
  name	String	Domain name of delegated party B.
  id	String	Domain ID of delegated party B.

  Table 4 token.catalog

  Parameter	Type	Description
  endpoints	Array of objects	Endpoint information.
  id	String	Service ID.
  name	String	Service name.
  type	String	Type of the service to which the API belongs.

  Table 5 token.catalog.endpoints

  Parameter	Type	Description
  id	String	Endpoint ID.
  interface	String	Visibility of the API. public indicates that the API is available for public access.
  region	String	Region to which the endpoint belongs.
  region_id	String	Region ID.
  url	String	Endpoint URL.

  Table 6 token.domain

  Parameter	Type	Description
  name	String	Domain name of the delegating party A.
  id	String	Domain ID of the delegating party A.

  Table 7 token.project

  Parameter	Type	Description
  name	String	Project name of delegating party A.
  id	String	Project ID of delegating party A.
  domain	Object	Domain information about delegating party A.

  Table 8 token.project.domain

  Parameter	Type	Description
  name	String	Domain name of the delegating party A.
  id	String	Domain ID of the delegating party A.

  Table 9 token.roles

  Parameter	Type	Description
  name	String	Permission name.
  id	String	Permission ID. The default value is 0, which does not correspond to any permission.

  Table 10 token.user

  Parameter	Type	Description
  name	String	Domain name or agency name of delegating party A.
  id	String	Agency ID.
  domain	Object	Domain information about delegating party A.

  Table 11 token.user.domain

  Parameter	Type	Description
  id	String	Domain ID of the delegating party A.
  name	String	Domain name of the delegating party A.

Status Codes