Skip to main content
API docs by Redocly

Identities (0.0.19)

Download OpenAPI specification:Download

Authentication

Authenticate a user Deprecated

Authenticates an identity and returns an Identity object containing information about the authenticated identity. The request body should contain the required credentials such as username and password.

Authorizations:
ApplicationToken
Request Body schema: application/json
credentials
string
object
object

Responses

Request samples

Content type
application/json
{
  • "password": "password123",
  • "username": "johndoe"
}

Response samples

Content type
application/json
{
  • "dateCreated": 16238912000,
  • "dateUpdated": 16238912000,
  • "id": 1,
  • "identifier": "johndoe",
  • "identityProfile": {
    },
  • "marcoId": "marco-1",
  • "status": "ENABLED",
  • "type": "USER"
}

Config

Gets the current config for an identity for a given Marco ID Deprecated

Authorizations:
ApplicationToken
path Parameters
marcoId
required
string

The marco Id of the config you want to add

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Updated the config for a give Marco ID Deprecated

Authorizations:
ApplicationToken
path Parameters
marcoId
required
string

The marco Id of the config you want to add

Request Body schema: application/json
Array of objects (ConfigItem)
Array
key
string
value
string

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Profile

Update identity profile Deprecated

Updates the values of the identity profile

Authorizations:
ApplicationToken
path Parameters
marcoId
required
string

The marco Id of the config you want to add

Request Body schema: application/json
displayName
string

Responses

Request samples

Content type
application/json
{
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "displayName": "string"
}

Set profile image Deprecated

Sets a profile image to the authorized requester

Authorizations:
ApplicationToken
Request Body schema: application/json
data
string
format
string

Responses

Request samples

Content type
application/json
{
  • "data": "string",
  • "format": "string"
}

Response samples

Content type
application/json
{
  • "displayName": "string"
}

Get profile image Deprecated

Get the profile image of an identity by its Marco ID

Authorizations:
ApplicationToken
path Parameters
marcoId
required
string

The marco Id of the config you want to add

Responses

Response samples

Content type
application/json
"string"

Identity

Get a list of identities with identifiers Deprecated

Authorizations:
ApplicationToken
query Parameters
filter_by
string (SearchByFilterEnum)
Default: "IDENTIFIER"
Enum: "IDENTIFIER" "MARCO_ID"

Field to match by when obtaining Identity. Default to IDENTIFIER

identifiers
Array of strings

Unique Marco identifier or Marco ID of the identity to get.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Identity Deprecated

Create a new Identity

Authorizations:
ApplicationToken
Request Body schema: application/json
dateCreated
integer <int64>
dateUpdated
integer <int64>
id
integer <int64>
identifier
string
object (Profile)
marcoId
string
status
string (StatusEnum)
Enum: "ENABLED" "DISABLED" "LOCKED" "PENDING"
type
string (LoginTypeEnum)
Enum: "USER" "SERVICE" "SAML"

Responses

Request samples

Content type
application/json
{
  • "dateCreated": 0,
  • "dateUpdated": 0,
  • "id": 0,
  • "identifier": "string",
  • "identityProfile": {
    },
  • "marcoId": "string",
  • "status": "ENABLED",
  • "type": "USER"
}

Response samples

Content type
application/json
{
  • "dateCreated": 0,
  • "dateUpdated": 0,
  • "id": 0,
  • "identifier": "string",
  • "identityProfile": {
    },
  • "marcoId": "string",
  • "status": "ENABLED",
  • "type": "USER"
}

Get specific Identity Deprecated

Returns the Identity for provided targetIdentity

Authorizations:
ApplicationToken
path Parameters
id
required
string

The ID of the identity that you want to perform an action

query Parameters
filter_by
string (SearchByFilterEnum)
Default: "IDENTIFIER"
Enum: "IDENTIFIER" "MARCO_ID"

Field to match by when obtaining Identity. Default to IDENTIFIER

Responses

Response samples

Content type
application/json
{
  • "dateCreated": 0,
  • "dateUpdated": 0,
  • "id": 0,
  • "identifier": "string",
  • "identityProfile": {
    },
  • "marcoId": "string",
  • "status": "ENABLED",
  • "type": "USER"
}

Update an Identities status Deprecated

Authorizations:
ApplicationToken
path Parameters
id
required
string

The ID of the identity that you want to perform an action

query Parameters
status
string (StatusEnum)
Enum: "ENABLED" "DISABLED" "LOCKED" "PENDING"

The status that you want the Identity to be updated with

Responses

Response samples

Content type
application/json
{
  • "dateCreated": 0,
  • "dateUpdated": 0,
  • "id": 0,
  • "identifier": "string",
  • "identityProfile": {
    },
  • "marcoId": "string",
  • "status": "ENABLED",
  • "type": "USER"
}

List of Identity filtered by their `identifier` field. Deprecated

Returns a list of Identity containing searchCriteria on their identifier field.

Authorizations:
ApplicationToken
path Parameters
searchCriteria
required
string

Search criteria to match Identity identifier.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return the Identity of the current logged in user Deprecated

Authorizations:
ApplicationToken

Responses

Response samples

Content type
application/json
{
  • "dateCreated": 0,
  • "dateUpdated": 0,
  • "id": 0,
  • "identifier": "string",
  • "identityProfile": {
    },
  • "marcoId": "string",
  • "status": "ENABLED",
  • "type": "USER"
}

Resource

List of Identities that are contained in resources Deprecated

Authorizations:
ApplicationToken
path Parameters
searchCriteria
required
string

Search criteria to match Identity identifier.

query Parameters
resources
Array of strings

The resource Id's that you want to return the associated Identities of.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List identities of a resource Deprecated

Authorizations:
ApplicationToken
path Parameters
resourceId
required
string

The resource Id that you want to return the associated Identities of.

Responses

Response samples

Content type
application/json
[
  • {
    }
]