API Operations for Client Developers

Some of these operations require only the core authentication service API v2.0 and some require extensions to the API. If an extension is required, it is included in The Rackspace implementation of the Keystone Identity Service; issuing the calls as described here uses the API extensions as needed.

MethodURIDescription
API Contract Version
GET/

Lists information about all Identity API versions.

GET/v2.0

Shows details for the Identity API v2.0.

Extensions
GET/v2.0/extensions

Lists available extensions.

GET/v2.0/extensions/{alias}

Gets detailed information for a specified extension.

Users
POST/v2.0/users

Adds a user.

GET/v2.0/users/​{?name,​email}

Lists users.

GET/v2.0/users/{userId}

Gets detailed account information for a user with the specified ID.

POST/v2.0/users/{userId}

Updates user information, settings, and password.

DELETE/v2.0/users/{userId}

Deletes a user.

POST/v2.0/users/{userId}/OS-KSADM/credentials

Adds a credential to a user.

GET/v2.0/users/{userId}/OS-KSADM/credentials

Lists credentials, other than passwords, for all authentication methods.

GET/v2.0/users/{userId}/OS-KSADM/credentials/

Gets user credentials.

POST/v2.0/users/{userId}/OS-KSADM/credentials/RAX-KSKEY:apiKeyCredentials/RAX-AUTH/reset

Reset user API key.

Roles
GET/v2.0/OS-KSADM/roles

Lists roles.

GET/v2.0/OS-KSADM/roles/{roleId}

Gets a role by role ID.

GET/v2.0/users/{userId}/roles/OS-KSADM

Returns global roles for a specific user.

PUT/v2.0/users/{userId}/roles/OS-KSADM/{roleid}

Adds a specific multiproduct or custom (product-specific) role to a user.

GET/v2.0/users/{userId}/roles/OS-KSADM/{roleid}

Returns information about a specified role assigned to a specified user.

DELETE/v2.0/users/{userId}/roles/OS-KSADM/{roleid}

Deletes a multiproduct or custom (product-specific) role from a user.

Authentication tokens
POST/v2.0/tokens

Authenticates using either a password or API key and generates an authentication token.

POST/v2.0/tokens

Allows Administrator users to authenticate by using a tenant id or name and a valid token.

POST/v2.0/tokens/

Authenticate with multifactor passcode credentials.

DELETE/v2.0/tokens/{tokenId}

Revoke token.

Tenants
GET/v2.0/tenants

Get a list of tenants.

Multifactor
POST/v2.0/users/{userId}/RAX-AUTH/multi-factor/mobile-phones

Adds a mobile phone number to the specified user account to support multi-factor authentication.

POST/v2.0/users/{userId}/RAX-AUTH/multi-factor/mobile-phones/{phoneId}/verificationcode

Sends a verification code to a mobile phone associated with a user account to verify that the user has the phone.

POST/v2.0/users/{userId}/RAX-AUTH/multi-factor/mobile-phones/{phoneId}/verify

Submits a PIN code issued by Rackspace verification services to confirm user possession of a device.

PUT/v2.0/users/{userId}/RAX-AUTH/multi-factor/mobile-phones

Enables or disables the multi-factor authentication setting for the specified account.

DELETE/v2.0/users/{userId}/RAX-AUTH/multi-factor/mobile-phones

Removes the multi-factor authentication setting and all associated mobile phones from your user account.

GET/v2.0/users/{userId}/RAX-AUTH/multi-factor/mobile-phones

Lists phones associated with the specified user account.

POST/v2.0/users/{userId}/RAX-AUTH/multi-factor/bypass-codes

Generates a bypass code that can be substituted for a multi-factor authentication passcode.



loading table of contents...