Pitchfork - Identity

Tokens

Authenticate With Key

/v2.0/tokens

Authenticate user using API Key and username

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	username		text	Yes	User name of user trying to autneticate
	api_key		text	Yes	API Key for user trying to authenticate

* Required for API Call

Authenticate With Password

/v2.0/tokens

None

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	username		text	Yes	Username of cloud account
	password		text	Yes	Password of cloud account

* Required for API Call

Multi-Factor Authentication

/v2.0/tokens

Authenticate with multi-factor authentication

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	session_id		text	Yes	Session ID header returned when authenticating will password credentials
	passcode_credentials		text	Yes	Passcode credentials needed to authenticate

* Required for API Call

Revoke Token

/v2.0/tokens/{token_id}

Revoke specified token

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	token_id		text	Yes	Token ID

* Required for API Call

Validate Token

/v2.0/tokens/{token_id}

Validate the supplied token and confirm owned by the tenant

View Documentation

	Parameter		Type	Required	Description
	token_id		text	Yes	Token

* Required for API Call

Users

Add Credential To User

/v2.0/users/{user_id}/OS-KSADM/credentials

Add a credential to the specified user

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	user_id		text	Yes	User UUID

* Required for API Call

Add User

/v2.0/users

Add a user

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
username	text	Yes	New username to be added
password	text	No	Password for new user
user_email	text	No	Email address for new user
user_enabled	boolean	No	Initial enabled status of new user

* Required for API Call

Delete User

/v2.0/users/{user_id}

Delete the specified user

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	user_id		text	Yes	User ID Number

* Required for API Call

Get Account Admin

/v2.0/users/{user_id}/RAX-AUTH/admins

Retrieves the administrator for the supplied account

View Documentation

	Parameter		Type	Required	Description
	user_id		text	Yes	User UUID

* Required for API Call

Get User By Email

/v2.0/users?email={email}

Get user details using the specified email address

View Documentation

	Parameter		Type	Required	Description
	email		text	Yes	Users email address

* Required for API Call

Get User By Id

/v2.0/users/{user_id}

Get details about user based on the specified user ID number

View Documentation

	Parameter		Type	Required	Description
	user_id		text	Yes	User ID Number

* Required for API Call

Get User By Name

/v2.0/users?name={username}

Get details user information about a single specified user

View Documentation

	Parameter		Type	Required	Description
	username		text	Yes	User name of user

* Required for API Call

Get User Credentials

/v2.0/users/{user_id}/OS-KSADM/credentials/RAX-KSKEY:apiKeyCredentials

Get user credentials for the current user (User who authenticated)

View Documentation

	Parameter		Type	Required	Description
	user_id		text	Yes	User ID Number

* Required for API Call

List Crendentials

/v2.0/users/{user_id}/OS-KSADM/credentials/

List credentials for all authentication methods (User who is currently authenticated)

View Documentation

	Parameter		Type	Required	Description
	user_id		text	Yes	User ID Number

* Required for API Call

List Users

/v2.0/users

List users. If not using the admin role then the request will only show the current user.

View Documentation

	Parameter		Type	Required	Description
Filter		text	No	Filter parameters i.e. limit=100. For multiple parameters separate using an & i.e. limit=100&marker=100

* Required for API Call

Reset User Api Key

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

Reset the users API key

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	user_id		text	Yes	User ID Number

* Required for API Call

Update User

/v2.0/users/{user_id}

Update details about a user

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
user_id	text	Yes	User ID Number
username	text	No	Username of user
password	text	No	Password for user
user_email	text	No	Email address for user
user_enabled	boolean	No	User enabled or not
user_region	text	No	User default region

* Required for API Call

Roles

Add Role To User

/v2.0/users/{user_id}/roles/OS-KSADM/{role_id}

Add specified role to the specified user

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	user_id		text	Yes	User ID
	role_id		text	Yes	Role ID

* Required for API Call

Delete Role From User

/v2.0/users/{user_id}/roles/OS-KSADM/{role_id}

Delete the specified role from the specified user

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	user_id		text	Yes	User ID
	role_id		text	Yes	Role ID

* Required for API Call

Get Role Details

/v2.0/OS-KSADM/roles/{role_id}

Get all role details

View Documentation

	Parameter		Type	Required	Description
	role_id		text	Yes	Role ID

* Required for API Call

List Roles

/v2.0/OS-KSADM/roles

List all roles

View Documentation

	Parameter		Type	Required	Description
Filter		text	No	Filter parameters i.e. limit=100. For multiple parameters separate using an & i.e. limit=100&marker=100

* Required for API Call

List Roles For User

/v2.0/users/{user_id}/roles

Returns global roles for a specified user

View Documentation

	Parameter		Type	Required	Description
	user_id		text	Yes	User ID Number

* Required for API Call

Tenants

Get Tenants

/v2.0/tenants

Domains

Get Domain Details

/v2.0/RAX-AUTH/domains/{domain_id}

Get details about the specified domain

View Documentation

	Parameter		Type	Required	Description
	domain_id		text	Yes	Domain ID

* Required for API Call

Retrieve Domains

/v2.0/RAX-AUTH/domains

Extensions

Get Extension Details

/v2.0/extensions/{extension_name}

Get details about the supplied extension

View Documentation

	Parameter		Type	Required	Description
	extension_name		text	Yes	Extension name or alias

* Required for API Call

List Extensions

/v2.0/extensions

Contract Versions

List Versions

Shw Version Details

/v2.0

Identity - API Calls

Tokens

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Users

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers